SPB Git

spb/doc-api

Public

# title: Collaborators url: https://platform.claude.com/docs/en/api/compliance/apps/projects/collaborators

# 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)

    default: 20, maximum: 100, minimum: 1

  • 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.

# Headers

  • "x-api-key": optional string

# Returns

  • data: array of ComplianceProjectUserCollaborator or ComplianceProjectGroupCollaborator or ComplianceProjectOrganizationCollaborator or ComplianceProjectOrganizationRoleCollaborator

    List of collaborators sorted chronologically by granted_at, tie break by the underlying role-assignment UUID

    • ComplianceProjectUserCollaborator object

      An individual user granted a role on a project.

      • type: "user"

        Discriminator marking this as an individual user collaborator

        default: user

      • granted_at: string

        When this collaborator was granted access (RFC 3339 format)

        format: date-time

      • role: "admin" or "editor" or "owner" or "viewer"

        Role granted on the project

        • "admin"

        • "editor"

        • "owner"

        • "viewer"

      • user_id: string or null

        Identifier of the user granted access (tagged ID), or null if their account has since been deleted

    • ComplianceProjectGroupCollaborator object

      An RBAC group granted a role on a project.

      • type: "group"

        Discriminator marking this as a group collaborator

        default: group

      • granted_at: string

        When this collaborator was granted access (RFC 3339 format)

        format: date-time

      • 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"

    • ComplianceProjectOrganizationCollaborator object

      An entire organization granted a role on a project.

      • type: "organization"

        Discriminator marking this as an organization-wide grant

        default: organization

      • granted_at: string

        When this collaborator was granted access (RFC 3339 format)

        format: date-time

      • 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"

    • ComplianceProjectOrganizationRoleCollaborator object

      All holders of an organization-level role granted a role on a project.

      • type: "organization_role"

        Discriminator marking this as a grant to all organization members holding a specific org-level role

        default: organization_role

      • granted_at: string

        When this collaborator was granted access (RFC 3339 format)

        format: date-time

      • 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"

  • has_more: boolean

    Whether more records exist beyond the current result set

  • next_page: string or null

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

# Example

bash
curl https://api.anthropic.com/v1/compliance/apps/projects/$PROJECT_ID/collaborators \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

# Response (200)

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 = ComplianceProjectUserCollaborator or ComplianceProjectGroupCollaborator or ComplianceProjectOrganizationCollaborator or ComplianceProjectOrganizationRoleCollaborator

    • ComplianceProjectUserCollaborator object

      An individual user granted a role on a project.

      • type: "user"

        Discriminator marking this as an individual user collaborator

        default: user

      • granted_at: string

        When this collaborator was granted access (RFC 3339 format)

        format: date-time

      • role: "admin" or "editor" or "owner" or "viewer"

        Role granted on the project

        • "admin"

        • "editor"

        • "owner"

        • "viewer"

      • user_id: string or null

        Identifier of the user granted access (tagged ID), or null if their account has since been deleted

    • ComplianceProjectGroupCollaborator object

      An RBAC group granted a role on a project.

      • type: "group"

        Discriminator marking this as a group collaborator

        default: group

      • granted_at: string

        When this collaborator was granted access (RFC 3339 format)

        format: date-time

      • 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"

    • ComplianceProjectOrganizationCollaborator object

      An entire organization granted a role on a project.

      • type: "organization"

        Discriminator marking this as an organization-wide grant

        default: organization

      • granted_at: string

        When this collaborator was granted access (RFC 3339 format)

        format: date-time

      • 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"

    • ComplianceProjectOrganizationRoleCollaborator object

      All holders of an organization-level role granted a role on a project.

      • type: "organization_role"

        Discriminator marking this as a grant to all organization members holding a specific org-level role

        default: organization_role

      • granted_at: string

        When this collaborator was granted access (RFC 3339 format)

        format: date-time

      • 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"

Files · main
Menu

Theme