Claude Platform Docs

List Users

$client->organization->users->list(?string afterID, ?string beforeID, ?string email, ?int limit, ?list<string> roles): Page<OrganizationUser>
GET/v1/organizations/users

List the organization's members.

Parameters
afterID?:optional string⁠Query parameter

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

beforeID?:optional string⁠Query parameter

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⁠Query parameter

Filter by user email.

limit?:optional int⁠Query parameter

Number of items to return per page.

Defaults to 20. Ranges from 1 to 1000.

default20
roles?:optional list<string>⁠Query parameter

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
class OrganizationUser { $type = 'user'; $id; $addedAt; /* 3 more */ }
"user" type

Object type.

For Users, this is always "user".

string id

ID of the User.

\Datetime addedAt

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

string email

Email of the User.

string name

Name of the User.

Organization role of the User.

List Users
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Anthropic\Client;

$client = new Client(apiKey: 'my-anthropic-api-key');

$page = $client->organization->users->list(
  afterID: 'after_id',
  beforeID: 'before_id',
  email: 'dev@stainless.com',
  limit: 1,
  roles: ['string'],
);

var_dump($page);
Returns Examples
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"
}