Claude Platform Docs

List Workspace Rate Limits

$client->organization->workspaces->rateLimits->list(string workspaceID, ?GroupType groupType, ?bool includeInherited, ?int limit, ?string page): PageCursor<WorkspaceRateLimit>
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

List a workspace's rate limits.

By default, returns only the groups and limiter types that have a workspace-level override. With include_inherited=true, returns every group with organization-level limits the workspace can see, listing for each the values it inherits from the organization as well as its own overrides. Each value's source says which it is.

When limit is omitted, every matching entry is returned in a single page; when limit truncates the result, follow next_page to fetch the remaining entries.

Parameters
workspaceID: string⁠Path parameter

The ID of the workspace.

groupType?:optional GroupType⁠Query parameter

Filter by group type.

includeInherited?:optional bool⁠Query parameter

Also list the limiter values the workspace inherits from the organization, including groups with no workspace-level override.

defaultfalse
limit?:optional int⁠Query parameter

Maximum number of items to return per page. Ranges from 1 to 1000.

When omitted, every remaining entry is returned in a single page and next_page is null.

page?:optional string⁠Query parameter

Opaque cursor from a previous response's next_page.

Returns
class WorkspaceRateLimit { $type = 'workspace_rate_limit'; $group; $limits; /* 3 more */ }
"workspace_rate_limit" type

Object type. Always workspace_rate_limit for workspace rate-limit entries.

Group group

The rate-limit group this entry's limits apply to.

list<WorkspaceRateLimitValue> limits

The workspace's limiter values for this group. By default only the limiter types with a workspace-level override are listed. With include_inherited set to true, the limiter types the workspace inherits from the organization are listed too, each marked by source.

?list<string> models

Model names this entry's limits apply to, including aliases. null when group.type is not "model_group". The list covers the models this workspace has access to, so it can differ between workspaces.

string rateLimitID

The id of the organization's RateLimit entry this entry applies to.

string workspaceID

ID of the Workspace this entry applies to.

List Workspace Rate Limits
<?php

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

use Anthropic\Client;

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

$page = $client->organization->workspaces->rateLimits->list(
  'workspace_id',
  groupType: 'batch',
  includeInherited: true,
  limit: 1,
  page: 'page',
);

var_dump($page);
Returns Examples
Response 200
{
  "data": [
    {
      "group": {
        "id": "id",
        "display_name": "display_name",
        "type": "model_group"
      },
      "limits": [
        {
          "org_limit": 0,
          "source": {
            "type": "workspace"
          },
          "type": "type",
          "value": 0
        }
      ],
      "models": [
        "string"
      ],
      "rate_limit_id": "rate_limit_id",
      "type": "workspace_rate_limit",
      "workspace_id": "workspace_id"
    }
  ],
  "next_page": "next_page"
}