Organization › Users

List Users

GET /v1/organizations/users

List the organization's members.

Query parameters

• after_id: optional string

  ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.

• before_id: optional string

  ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.

• email: optional string

  Filter by user email.

  format: email

• limit: optional number

  Number of items to return per page.

  Defaults to 20. Ranges from 1 to 1000.

  default: 20, maximum: 1000, minimum: 1

• roles: optional array of string

  Filter to items whose role equals one of the supplied values. Repeatable; values are OR'ed together.

  Accepted values depend on the organization type: Console and API organizations accept user, developer, billing, admin, and claude_code_user; Claude Enterprise organizations accept user, owner, primary_owner, membership_admin, and managed.

Returns

• data: array of BetaOrganizationUser

  • type: "user"

    Object type.

    For Users, this is always "user".

    default: user

  • id: string

    ID of the User.

  • added_at: string

    RFC 3339 datetime string indicating when the User joined the Organization.

    format: date-time

  • email: string

    Email of the User.

  • name: string

    Name of the User.

  • role: BetaOrganizationRole

    Organization role of the User.

    • "admin"

    • "billing"

    • "claude_code_user"

    • "developer"

    • "managed"

    • "membership_admin"

    • "owner"

    • "primary_owner"

    • "user"

• first_id: string or null

  First ID in the data list. Can be used as the before_id for the previous page.

• has_more: boolean

  Indicates if there are more results in the requested page direction.

• last_id: string or null

  Last ID in the data list. Can be used as the after_id for the next page.

Example

curl https://api.anthropic.com/v1/organizations/users \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

Response (200)

{
  "data": [
    {
      "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
      "added_at": "2024-10-30T23:58:27.427722Z",
      "email": "user@emaildomain.com",
      "name": "Jane Doe",
      "role": "admin",
      "type": "user"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

Get User

GET /v1/organizations/users/\{user_id\}

Retrieve a member of the organization by user ID.

Path parameters

• user_id: string

  ID of the User.

Returns

• BetaOrganizationUser object

  • type: "user"

    Object type.

    For Users, this is always "user".

    default: user

  • id: string

    ID of the User.

  • added_at: string

    RFC 3339 datetime string indicating when the User joined the Organization.

    format: date-time

  • email: string

    Email of the User.

  • name: string

    Name of the User.

  • role: BetaOrganizationRole

    Organization role of the User.

    • "admin"

    • "billing"

    • "claude_code_user"

    • "developer"

    • "managed"

    • "membership_admin"

    • "owner"

    • "primary_owner"

    • "user"

Example

curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

Response (200)

{
  "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "added_at": "2024-10-30T23:58:27.427722Z",
  "email": "user@emaildomain.com",
  "name": "Jane Doe",
  "role": "admin",
  "type": "user"
}

Update User

POST /v1/organizations/users/\{user_id\}

Update a member's organization role.

Path parameters

• user_id: string

  ID of the User.

Body parameters

• role: "billing" or "claude_code_user" or "developer" or 2 more

  New role for the User.

  The accepted values depend on the organization type. Console and API organizations accept user, developer, billing, and claude_code_user; admin cannot be assigned through the API. Claude Enterprise organizations accept user and managed.

  • "billing"

  • "claude_code_user"

  • "developer"

  • "managed"

  • "user"

Returns

• BetaOrganizationUser object

  • type: "user"

    Object type.

    For Users, this is always "user".

    default: user

  • id: string

    ID of the User.

  • added_at: string

    RFC 3339 datetime string indicating when the User joined the Organization.

    format: date-time

  • email: string

    Email of the User.

  • name: string

    Name of the User.

  • role: BetaOrganizationRole

    Organization role of the User.

    • "admin"

    • "billing"

    • "claude_code_user"

    • "developer"

    • "managed"

    • "membership_admin"

    • "owner"

    • "primary_owner"

    • "user"

Example

curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY" \
    -d '{
          "role": "user"
        }'

Response (200)

{
  "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "added_at": "2024-10-30T23:58:27.427722Z",
  "email": "user@emaildomain.com",
  "name": "Jane Doe",
  "role": "admin",
  "type": "user"
}

Remove User

DELETE /v1/organizations/users/\{user_id\}

Remove a member from the organization.

Path parameters

• user_id: string

  ID of the User.

Returns

• type: "user_deleted"

  Deleted object type.

  For Users, this is always "user_deleted".

  default: user_deleted

• id: string

  ID of the User.

Example

curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
    -X DELETE \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

Response (200)

{
  "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "type": "user_deleted"
}