---
title: Rate Limits
url: https://platform.claude.com/docs/en/api/php/organization/workspaces/rate_limits
---

# Rate Limits

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

  default: false

- `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`

  - `"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.

### Example

```php
<?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);
```

#### Response (200)

```json
{
  "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"
}
```

## Set Workspace Rate Limits

`$client->organization->workspaces->rateLimits->update(string rateLimitID, string workspaceID, list<WorkspaceRateLimitUpdateValue> limits): WorkspaceRateLimit`

**POST** `/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}`

Set or clear rate-limit overrides for one rate-limit group in a workspace.

Only the limiter types named in `limits` change: an integer `value` sets
that type's override and `null` clears it. Types not named keep their
current value. A value above the organization's own limit is stored, but
the organization limit still applies, so the lower of the two is
enforced.

Returns the targeted group's entry with this request applied, in the shape
`GET /v1/organizations/workspaces/{workspace_id}/rate_limits` returns.
Changes take effect within about an hour.

### Parameters

- `workspaceID: string` (path parameter)

  The ID of the workspace.

- `rateLimitID: string` (path parameter)

  The `id` of the organization's rate-limit entry to set overrides for.

- `limits: list<WorkspaceRateLimitUpdateValue>`

  Limits to set or clear. Unspecified limit types are unchanged.

### Returns

- `class WorkspaceRateLimit`

  - `"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.

### Example

```php
<?php

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

use Anthropic\Client;
use Anthropic\Organization\Workspaces\RateLimits\WorkspaceRateLimitType;

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

$workspaceRateLimit = $client->organization->workspaces->rateLimits->update(
  'rate_limit_id',
  workspaceID: 'workspace_id',
  limits: [['type' => WorkspaceRateLimitType::FAST_ITPMCA, 'value' => 0]],
);

var_dump($workspaceRateLimit);
```

#### Response (200)

```json
{
  "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"
}
```

## Domain types

### Workspace Rate Limit

- `class WorkspaceRateLimit`

  - `"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.

### Workspace Rate Limit Organization Source

- `class WorkspaceRateLimitOrganizationSource`

  - `"organization" type`

    Always `organization`: no workspace-level override is stored, so the organization's value applies.

### Workspace Rate Limit Type

- `enum WorkspaceRateLimitType`

  - `"fast_itpmca"`

  - `"fast_otpm"`

  - `"input_tokens_per_minute"`

  - `"input_tokens_per_minute_cache_aware"`

  - `"output_tokens_per_minute"`

  - `"requests_per_minute"`

  - `"tokens_per_day"`

  - `"tokens_per_minute"`

  - `"tool_uses_per_second"`

### Workspace Rate Limit Update Value

- `class WorkspaceRateLimitUpdateValue`

  - `WorkspaceRateLimitType type`

    Rate limiter type.

  - `?int value`

    New limit value. Set to null to clear the workspace override and fall back to the organization limit.

### Workspace Rate Limit Value

- `class WorkspaceRateLimitValue`

  - `string type`

    The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).

  - `?int orgLimit`

    The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.

  - `Source source`

    Where `value` comes from. `organization` values are listed only when `include_inherited` is `true`, and then `value` equals `org_limit`.

  - `int value`

    The workspace's value for this limiter type: the workspace-level override when `source.type` is `workspace`, otherwise the organization's value.

### Workspace Rate Limit Workspace Source

- `class WorkspaceRateLimitWorkspaceSource`

  - `"workspace" type`

    Always `workspace`: a workspace-level override is stored.