Projects

List projects

get /v1/compliance/apps/projects

Lists project metadata with filtering capabilities. Results are sorted chronologically (time ascending) by created_at.

Query Parameters

• created_at: optional object { gt, gte, lt, lte }

  • gt: optional string

    Filter projects created after this time (RFC 3339 format)

  • gte: optional string

    Filter projects created at or after this time (RFC 3339 format)

  • lt: optional string

    Filter projects created before this time (RFC 3339 format)

  • lte: optional string

    Filter projects created at or before this time (RFC 3339 format)

• limit: optional number

  Maximum results (default: 20, max: 100)

• organization_ids: optional array of string

  Filter by organization IDs (accepts org_... or organization UUID). Enumerate IDs via GET /v1/compliance/organizations.

• page: optional string

  Opaque pagination token from a previous response's next_page field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.

• user_ids: optional array of string

  Filter by user IDs. Enumerate IDs via GET /v1/compliance/organizations/{org_uuid}/users.

Header Parameters

• "x-api-key": optional string

Returns

• data: array of object { id, created_at, deleted_at, 6 more }

  List of projects sorted by creation date ascending

  • id: string

    Project identifier (tagged ID)

  • created_at: string

    Project creation timestamp

  • deleted_at: string

    Timestamp when the project was deleted by an end user, or null otherwise

  • is_private: boolean

    If false, the project is visible to all organization members; if true the project is accessible only to the creator and specified collaborators

  • name: string

    Project name

  • organization_id: string

    Organization identifier (tagged ID)

  • organization_uuid: string

    Organization UUID this project belongs to

  • updated_at: string

    Project last update timestamp

  • user: object { id, email_address }

    User information for project creator.

    • id: string

      User identifier (tagged ID)

    • email_address: string

      User's email address

• has_more: boolean

  Whether more records exist beyond the current result set

• next_page: string

  Token to retrieve the next page. Use this as the 'page' parameter in your next request

Example

curl https://api.anthropic.com/v1/compliance/apps/projects \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "data": [
    {
      "id": "claude_proj_abc123",
      "name": "Q4 Product Planning",
      "created_at": "2025-06-01T10:00:00Z",
      "updated_at": "2025-06-15T14:30:00Z",
      "is_private": true,
      "organization_id": "org_abc123",
      "organization_uuid": "abc12345-6789-0abc-def0-123456789abc",
      "user": {
        "id": "user_xyz456",
        "email_address": "user@example.com"
      }
    }
  ],
  "has_more": true,
  "next_page": "page_eyJjcmVhdGVkX2F0IjoiMjAyNS0wNi0wMVQxMDowMDowMFoiLCJ1dWlkIjoiYWJjMTIzIn0="
}

Get project details

get /v1/compliance/apps/projects/{project_id}

Get detailed information for a specific project.

Returns: Detailed project information including description, instructions, and counts

Path Parameters

• project_id: string

  The project ID (tagged ID, e.g., claude_proj_abc123)

Header Parameters

• "x-api-key": optional string

Returns

• id: string

  Project identifier (tagged ID)

• attachments_count: number

  Number of attachments contained within this project

• chats_count: number

  Number of chats contained within this project

• created_at: string

  Project creation timestamp

• deleted_at: string

  Timestamp when the project was deleted by an end user, or null otherwise

• description: string

  Project description

• instructions: string

  Project's custom instructions / prompt

• is_private: boolean

  If false, the project is visible to all organization members; if true the project is accessible only to the creator and specified collaborators

• name: string

  Project name

• organization_id: string

  Organization identifier (tagged ID)

• organization_uuid: string

  Organization UUID this project belongs to

• updated_at: string

  Project last update timestamp

• user: object { id, email_address }

  User information for project creator.

  • id: string

    User identifier (tagged ID)

  • email_address: string

    User's email address

Example

curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "id": "id",
  "attachments_count": 0,
  "chats_count": 0,
  "created_at": "2019-12-27T18:11:19.117Z",
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "instructions": "instructions",
  "is_private": true,
  "name": "name",
  "organization_id": "organization_id",
  "organization_uuid": "organization_uuid",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "user": {
    "id": "id",
    "email_address": "email_address"
  }
}

Delete project

delete /v1/compliance/apps/projects/{project_id}

Delete a project for compliance purposes.

Hard-deletes the project and all its associated data including:

• All project documents and files
• All role assignments
• Knowledge base (if RAG is enabled)
• Sync sources

Project must have no attached chats - returns 409 if chats exist.

Returns: ClaudeProjectDeleteResponse confirming the deletion

Raises: ConflictException: If project has chats attached NotFoundException: If project doesn't exist or already deleted

Path Parameters

• project_id: string

  The project ID (tagged ID, e.g., claude_proj_abc123)

Header Parameters

• "x-api-key": optional string

Returns

• id: string

  The ID of the Claude project that was deleted

• type: optional "claude_project_deleted"

  Constant string confirming deletion.

  • "claude_project_deleted"

Example

curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID \
    -X DELETE \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "id": "id",
  "type": "claude_project_deleted"
}

Domain Types

Project List Response

• ProjectListResponse object { id, created_at, deleted_at, 6 more }

  Project information for compliance responses.

  • id: string

    Project identifier (tagged ID)

  • created_at: string

    Project creation timestamp

  • deleted_at: string

    Timestamp when the project was deleted by an end user, or null otherwise

  • is_private: boolean

    If false, the project is visible to all organization members; if true the project is accessible only to the creator and specified collaborators

  • name: string

    Project name

  • organization_id: string

    Organization identifier (tagged ID)

  • organization_uuid: string

    Organization UUID this project belongs to

  • updated_at: string

    Project last update timestamp

  • user: object { id, email_address }

    User information for project creator.

    • id: string

      User identifier (tagged ID)

    • email_address: string

      User's email address

Project Retrieve Response

• ProjectRetrieveResponse object { id, attachments_count, chats_count, 10 more }

  Detailed project information for compliance responses.

  • id: string

    Project identifier (tagged ID)

  • attachments_count: number

    Number of attachments contained within this project

  • chats_count: number

    Number of chats contained within this project

  • created_at: string

    Project creation timestamp

  • deleted_at: string

    Timestamp when the project was deleted by an end user, or null otherwise

  • description: string

    Project description

  • instructions: string

    Project's custom instructions / prompt

  • is_private: boolean

    If false, the project is visible to all organization members; if true the project is accessible only to the creator and specified collaborators

  • name: string

    Project name

  • organization_id: string

    Organization identifier (tagged ID)

  • organization_uuid: string

    Organization UUID this project belongs to

  • updated_at: string

    Project last update timestamp

  • user: object { id, email_address }

    User information for project creator.

    • id: string

      User identifier (tagged ID)

    • email_address: string

      User's email address

Project Delete Response

• ProjectDeleteResponse object { id, type }

  Response for deleting a Claude project.

  • id: string

    The ID of the Claude project that was deleted

  • type: optional "claude_project_deleted"

    Constant string confirming deletion.

    • "claude_project_deleted"

Attachments

List project attachments

get /v1/compliance/apps/projects/{project_id}/attachments

List files and documents attached to a project.

List files and project documents attached to the project referenced by project_id. This includes the IDs of attached files, and attached project documents.

The raw binary content of attached files can be downloaded using the GET /v1/compliance/apps/chats/files/{claude_file_id}/content endpoint.

The text content of attached project documents can be fetched using the GET /v1/compliance/apps/projects/documents/{claude_proj_doc_id} endpoint.

Returns: List of project attachments with pagination info

Raises: NotFoundException: If project doesn't exist or project_id format is invalid

Path Parameters

• project_id: string

  The project ID (tagged ID, e.g., claude_proj_abc123)

Query Parameters

• limit: optional number

  Maximum results (default: 20, max: 100)

• page: optional string

  Opaque pagination token from a previous response's next_page field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.

Header Parameters

• "x-api-key": optional string

Returns

• data: array of object { id, created_at, filename, 2 more } or object { id, created_at, filename, 2 more }

  List of attachments sorted chronologically by created_at, tie break by id

  • ComplianceProjectFileReference object { id, created_at, filename, 2 more }

    File attachment reference for compliance responses.

    • id: string

      File identifier (e.g., 'claude_file_abcd')

    • created_at: string

      Creation timestamp (RFC 3339 format)

    • filename: string

      Display name of the file (e.g., 'document.pdf')

    • mime_type: string

      MIME type of the file when it was uploaded (e.g., 'application/pdf')

    • type: "project_file"

      Discriminator marking this as a binary file

      • "project_file"

  • ComplianceProjectDocReference object { id, created_at, filename, 2 more }

    Project document attachment reference for compliance responses.

    • id: string

      Project document identifier (e.g., 'claude_proj_doc_abcd')

    • created_at: string

      Creation timestamp (RFC 3339 format)

    • filename: string

      Display name of the document (e.g., 'document.txt')

    • mime_type: "text/plain"

      MIME type of the project document, always set to plain text

      • "text/plain"

    • type: "project_doc"

      Discriminator marking this as a plain text document

      • "project_doc"

• has_more: boolean

  Whether more records exist beyond the current result set

• next_page: string

  To get the next page, use the 'next_page' from the current response as the 'page' in your next request

Example

curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/attachments \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "data": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "filename": "filename",
      "mime_type": "mime_type",
      "type": "project_file"
    }
  ],
  "has_more": true,
  "next_page": "next_page"
}

Domain Types

Attachment List Response

• AttachmentListResponse = object { id, created_at, filename, 2 more } or object { id, created_at, filename, 2 more }

  File attachment reference for compliance responses.

  • ComplianceProjectFileReference object { id, created_at, filename, 2 more }

    File attachment reference for compliance responses.

    • id: string

      File identifier (e.g., 'claude_file_abcd')

    • created_at: string

      Creation timestamp (RFC 3339 format)

    • filename: string

      Display name of the file (e.g., 'document.pdf')

    • mime_type: string

      MIME type of the file when it was uploaded (e.g., 'application/pdf')

    • type: "project_file"

      Discriminator marking this as a binary file

      • "project_file"

  • ComplianceProjectDocReference object { id, created_at, filename, 2 more }

    Project document attachment reference for compliance responses.

    • id: string

      Project document identifier (e.g., 'claude_proj_doc_abcd')

    • created_at: string

      Creation timestamp (RFC 3339 format)

    • filename: string

      Display name of the document (e.g., 'document.txt')

    • mime_type: "text/plain"

      MIME type of the project document, always set to plain text

      • "text/plain"

    • type: "project_doc"

      Discriminator marking this as a plain text document

      • "project_doc"

Documents

Get project document content

get /v1/compliance/apps/projects/documents/{document_id}

Get detailed information for a specific project document.

Returns: Project document information including content and metadata

Path Parameters

• document_id: string

  The document ID (tagged ID, e.g., claude_proj_doc_abc123)

Header Parameters

• "x-api-key": optional string

Returns

• id: string

  Project document identifier (tagged ID)

• content: string

  Document text content

• created_at: string

  Document creation timestamp

• filename: string

  Document filename

• user: object { id, email_address }

  User information for project creator.

  • id: string

    User identifier (tagged ID)

  • email_address: string

    User's email address

Example

curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "id": "id",
  "content": "content",
  "created_at": "2019-12-27T18:11:19.117Z",
  "filename": "filename",
  "user": {
    "id": "id",
    "email_address": "email_address"
  }
}

Get project document metadata

get /v1/compliance/apps/projects/documents/{document_id}/metadata

Returns metadata for a project document, without the content body.

Use the sibling GET /v1/compliance/apps/projects/documents/{document_id} endpoint to fetch the document text. The md5 and size_bytes fields here are computed over the UTF-8 encoding of that text, so a DLP consumer can dedupe or match hashes without downloading every document.

Path Parameters

• document_id: string

  The document ID (tagged ID, e.g., claude_proj_doc_abc123)

Header Parameters

• "x-api-key": optional string

Returns

• id: string

  Project document identifier (tagged ID)

• claude_project_id: string

  The project this document belongs to

• created_at: string

  Document creation timestamp

• filename: string

  Document filename

• md5: string

  Lowercase hex MD5 of the document content (UTF-8 encoded). Matches the content field returned by the sibling content endpoint.

• mime_type: "text/plain"

  MIME type of the document content, always plain text

  • "text/plain"

• size_bytes: number

  Size in bytes of the document content (UTF-8 encoded)

• user: object { id, email_address }

  User information for project creator.

  • id: string

    User identifier (tagged ID)

  • email_address: string

    User's email address

Example

curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID/metadata \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "id": "id",
  "claude_project_id": "claude_project_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "filename": "filename",
  "md5": "md5",
  "mime_type": "text/plain",
  "size_bytes": 0,
  "user": {
    "id": "id",
    "email_address": "email_address"
  }
}

Delete project document

delete /v1/compliance/apps/projects/documents/{document_id}

Delete a project document for compliance purposes.

Hard-deletes the project document permanently.

Returns: ComplianceProjectDocumentDeleteResponse confirming the deletion

Path Parameters

• document_id: string

  The document ID (tagged ID, e.g., claude_proj_doc_abc123)

Header Parameters

• "x-api-key": optional string

Returns

• id: string

  The ID of the project document that was deleted

• type: "claude_project_document_deleted"

  Constant string confirming deletion.

  • "claude_project_document_deleted"

Example

curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
    -X DELETE \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "id": "id",
  "type": "claude_project_document_deleted"
}

Domain Types

Document Retrieve Response

• DocumentRetrieveResponse object { id, content, created_at, 2 more }

  Project document information for compliance responses.

  • id: string

    Project document identifier (tagged ID)

  • content: string

    Document text content

  • created_at: string

    Document creation timestamp

  • filename: string

    Document filename

  • user: object { id, email_address }

    User information for project creator.

    • id: string

      User identifier (tagged ID)

    • email_address: string

      User's email address

Document Metadata Response

• DocumentMetadataResponse object { id, claude_project_id, created_at, 5 more }

  Project document metadata for GET /v1/compliance/apps/projects/documents/{document_id}/metadata.

  Returns metadata only. Use the sibling endpoint (without /metadata) to fetch the document text content.

  • id: string

    Project document identifier (tagged ID)

  • claude_project_id: string

    The project this document belongs to

  • created_at: string

    Document creation timestamp

  • filename: string

    Document filename

  • md5: string

    Lowercase hex MD5 of the document content (UTF-8 encoded). Matches the content field returned by the sibling content endpoint.

  • mime_type: "text/plain"

    MIME type of the document content, always plain text

    • "text/plain"

  • size_bytes: number

    Size in bytes of the document content (UTF-8 encoded)

  • user: object { id, email_address }

    User information for project creator.

    • id: string

      User identifier (tagged ID)

    • email_address: string

      User's email address

Document Delete Response

• DocumentDeleteResponse object { id, type }

  Response for deleting a project document.

  • id: string

    The ID of the project document that was deleted

  • type: "claude_project_document_deleted"

    Constant string confirming deletion.

    • "claude_project_document_deleted"