# 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 }` The user who created a project or project document. Fields that reference this type are null when the creator's account has been deleted or the creator is no longer a member of any organization under the parent organization. - `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 ```http curl https://api.anthropic.com/v1/compliance/apps/projects \ -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" ``` #### Response ```json { "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. ### 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 }` The user who created a project or project document. Fields that reference this type are null when the creator's account has been deleted or the creator is no longer a member of any organization under the parent organization. - `id: string` User identifier (tagged ID) - `email_address: string` User's email address ### Example ```http curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID \ -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" ``` #### Response ```json { "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. ### 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 ```http curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID \ -X DELETE \ -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" ``` #### Response ```json { "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 }` The user who created a project or project document. Fields that reference this type are null when the creator's account has been deleted or the creator is no longer a member of any organization under the parent organization. - `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 }` The user who created a project or project document. Fields that reference this type are null when the creator's account has been deleted or the creator is no longer a member of any organization under the parent organization. - `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. ### 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 ```http curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/attachments \ -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" ``` #### Response ```json { "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"` # Collaborators ## List project collaborators **get** `/v1/compliance/apps/projects/{project_id}/collaborators` List the users, groups, and organization-wide grants on a project. Each entry represents one active role assignment on the project. Principals are returned as a discriminated union on `type` — an individual user, an RBAC group, the whole organization, or all holders of an organization-level role. ### 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 { granted_at, role, type, user_id } or object { granted_at, group_id, role, type } or object { granted_at, organization_uuid, role, type } or object { granted_at, organization_role, role, type }` List of collaborators sorted chronologically by granted_at, tie break by the underlying role-assignment UUID - `ComplianceProjectUserCollaborator object { granted_at, role, type, user_id }` An individual user granted a role on a project. - `granted_at: string` When this collaborator was granted access (RFC 3339 format) - `role: "admin" or "editor" or "owner" or "viewer"` Role granted on the project - `"admin"` - `"editor"` - `"owner"` - `"viewer"` - `type: "user"` Discriminator marking this as an individual user collaborator - `"user"` - `user_id: string` Identifier of the user granted access (tagged ID), or null if their account has since been deleted - `ComplianceProjectGroupCollaborator object { granted_at, group_id, role, type }` An RBAC group granted a role on a project. - `granted_at: string` When this collaborator was granted access (RFC 3339 format) - `group_id: string` Identifier of the group granted access (tagged ID) - `role: "admin" or "editor" or "owner" or "viewer"` Role granted on the project - `"admin"` - `"editor"` - `"owner"` - `"viewer"` - `type: "group"` Discriminator marking this as a group collaborator - `"group"` - `ComplianceProjectOrganizationCollaborator object { granted_at, organization_uuid, role, type }` An entire organization granted a role on a project. - `granted_at: string` When this collaborator was granted access (RFC 3339 format) - `organization_uuid: string` UUID of the organization granted access - `role: "admin" or "editor" or "owner" or "viewer"` Role granted on the project - `"admin"` - `"editor"` - `"owner"` - `"viewer"` - `type: "organization"` Discriminator marking this as an organization-wide grant - `"organization"` - `ComplianceProjectOrganizationRoleCollaborator object { granted_at, organization_role, role, type }` All holders of an organization-level role granted a role on a project. - `granted_at: string` When this collaborator was granted access (RFC 3339 format) - `organization_role: string` The organization-level role whose holders are granted access - `role: "admin" or "editor" or "owner" or "viewer"` Role granted on the project - `"admin"` - `"editor"` - `"owner"` - `"viewer"` - `type: "organization_role"` Discriminator marking this as a grant to all organization members holding a specific org-level role - `"organization_role"` - `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 ```http curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/collaborators \ -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" ``` #### Response ```json { "data": [ { "granted_at": "2019-12-27T18:11:19.117Z", "role": "admin", "type": "user", "user_id": "user_id" } ], "has_more": true, "next_page": "next_page" } ``` ## Domain Types ### Collaborator List Response - `CollaboratorListResponse = object { granted_at, role, type, user_id } or object { granted_at, group_id, role, type } or object { granted_at, organization_uuid, role, type } or object { granted_at, organization_role, role, type }` An individual user granted a role on a project. - `ComplianceProjectUserCollaborator object { granted_at, role, type, user_id }` An individual user granted a role on a project. - `granted_at: string` When this collaborator was granted access (RFC 3339 format) - `role: "admin" or "editor" or "owner" or "viewer"` Role granted on the project - `"admin"` - `"editor"` - `"owner"` - `"viewer"` - `type: "user"` Discriminator marking this as an individual user collaborator - `"user"` - `user_id: string` Identifier of the user granted access (tagged ID), or null if their account has since been deleted - `ComplianceProjectGroupCollaborator object { granted_at, group_id, role, type }` An RBAC group granted a role on a project. - `granted_at: string` When this collaborator was granted access (RFC 3339 format) - `group_id: string` Identifier of the group granted access (tagged ID) - `role: "admin" or "editor" or "owner" or "viewer"` Role granted on the project - `"admin"` - `"editor"` - `"owner"` - `"viewer"` - `type: "group"` Discriminator marking this as a group collaborator - `"group"` - `ComplianceProjectOrganizationCollaborator object { granted_at, organization_uuid, role, type }` An entire organization granted a role on a project. - `granted_at: string` When this collaborator was granted access (RFC 3339 format) - `organization_uuid: string` UUID of the organization granted access - `role: "admin" or "editor" or "owner" or "viewer"` Role granted on the project - `"admin"` - `"editor"` - `"owner"` - `"viewer"` - `type: "organization"` Discriminator marking this as an organization-wide grant - `"organization"` - `ComplianceProjectOrganizationRoleCollaborator object { granted_at, organization_role, role, type }` All holders of an organization-level role granted a role on a project. - `granted_at: string` When this collaborator was granted access (RFC 3339 format) - `organization_role: string` The organization-level role whose holders are granted access - `role: "admin" or "editor" or "owner" or "viewer"` Role granted on the project - `"admin"` - `"editor"` - `"owner"` - `"viewer"` - `type: "organization_role"` Discriminator marking this as a grant to all organization members holding a specific org-level role - `"organization_role"` # Documents ## Get project document content **get** `/v1/compliance/apps/projects/documents/{document_id}` Get detailed information for a specific project 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) - `content: string` Document text content - `created_at: string` Document creation timestamp - `filename: string` Document filename - `user: object { id, email_address }` The user who created a project or project document. Fields that reference this type are null when the creator's account has been deleted or the creator is no longer a member of any organization under the parent organization. - `id: string` User identifier (tagged ID) - `email_address: string` User's email address ### Example ```http curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \ -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" ``` #### Response ```json { "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 }` The user who created a project or project document. Fields that reference this type are null when the creator's account has been deleted or the creator is no longer a member of any organization under the parent organization. - `id: string` User identifier (tagged ID) - `email_address: string` User's email address ### Example ```http curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID/metadata \ -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" ``` #### Response ```json { "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. ### 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 ```http curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \ -X DELETE \ -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" ``` #### Response ```json { "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 }` The user who created a project or project document. Fields that reference this type are null when the creator's account has been deleted or the creator is no longer a member of any organization under the parent organization. - `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 }` The user who created a project or project document. Fields that reference this type are null when the creator's account has been deleted or the creator is no longer a member of any organization under the parent organization. - `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"`