---
title: "Get a quota, with every scope key's value and usage"
description: "An unknown or deprecated quota is 404."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Service Quotas API

`GET /v1/organizations/{orgId}/quotas/{quota}`

An unknown or deprecated quota is 404.

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie
- `oauth`, http, header `Authorization`

## Path parameters

- `GetQuota.path.orgId` (string, required)
  - format `uuid`
- `GetQuota.path.quota` (string, required) — The quota's ID: widgets.widgetsPerProject.
  - maxLength 96; pattern `^[a-z]{2,32}\.[a-z][A-Za-z0-9]{2,63}(\.[a-z][A-Za-z0-9]{1,63})?$`

## Query parameters

- `GetQuota.query.scopeKey` (string, optional) — Only this scope key in scopes.
  - pattern `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`
- `GetQuota.query.region` (string, optional) — Only this region's rows of a perRegion quota; without it, a row per region.
  - pattern `^([a-z]{2}-[a-z]+-[0-9]+)?$`

## Code samples

### cURL

```curl
curl --request GET \
  --url https://quotas.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/quotas/string \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://quotas.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/quotas/string';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://quotas.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/quotas/string"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

The quota.

#### Example

```json
{
  "scopes": [
    {
      "capacity": 0,
      "region": "string",
      "scopeKey": "string",
      "source": "override",
      "tier": "string",
      "usage": {
        "periodStart": {},
        "resetsAt": {},
        "state": "available",
        "used": 0
      },
      "value": 0
    }
  ],
  "usageAvailable": true,
  "adjustable": true,
  "capacity": 0,
  "default": 0,
  "description": "string",
  "displayName": "string",
  "id": "string",
  "kind": "allocation",
  "perRegion": true,
  "region": "string",
  "resourceType": "string",
  "scope": "organization",
  "service": "string",
  "serviceName": "string",
  "source": "override",
  "tier": "string",
  "unit": "string",
  "usage": {},
  "usageSummary": {},
  "value": 0,
  "window": "string"
}
```

- `GetQuota.response.200.adjustable` (boolean, required)
- `GetQuota.response.200.capacity` (integer | null, required) — rate quotas: the bucket's capacity for value (what usage.used is out of), else null.
  - min 0
- `GetQuota.response.200.default` (integer, required) — The default for the organization's tier.
  - min 0
- `GetQuota.response.200.description` (string, required)
- `GetQuota.response.200.displayName` (string, required)
- `GetQuota.response.200.id` (string, required) — <namespace>.<name> or <namespace>.<group>.<name>.
  - maxLength 96; pattern `^[a-z]{2,32}\.[a-z][A-Za-z0-9]{2,63}(\.[a-z][A-Za-z0-9]{1,63})?$`
- `GetQuota.response.200.kind` (unknown, required)
  - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
- `GetQuota.response.200.perRegion` (boolean, required)
- `GetQuota.response.200.region` (string, required) — A region (us-west-1), or "" for what isn't regional.
  - pattern `^([a-z]{2}-[a-z]+-[0-9]+)?$`
- `GetQuota.response.200.resourceType` (string | null, required)
- `GetQuota.response.200.scope` (unknown, required)
  - one of `"organization"`, `"project"`, `"resource"`
- `GetQuota.response.200.service` (string, required) — The owning product's namespace.
- `GetQuota.response.200.serviceName` (string | null, required) — The owning product's name, from its registration (Widgets), or null.
- `GetQuota.response.200.source` (unknown, required) — Which value applied: an override for the scope key, one for the whole organization, the tier's default, or the quota's default.
  - one of `"override"`, `"organizationOverride"`, `"tier"`, `"default"`
- `GetQuota.response.200.tier` (string | null, required) — The organization's tier when source is tier, else null.
- `GetQuota.response.200.unit` (string, required)
- `GetQuota.response.200.usage` (one of, required) — null for narrower scopes without ?scopeKey= (see usageSummary and the quota's scopes), and for a perRegion quota without ?region=.
  - one of: `null`, [Usage](/quotas-api/schemas/Usage/)
- `GetQuota.response.200.usageSummary` (one of, required) — When usage is null: where the scope keys (and regions) stand. Else null.
  - one of: `null`, [UsageSummary](/quotas-api/schemas/UsageSummary/)
- `GetQuota.response.200.value` (integer, required) — The value that applies: the organization's, a scope key without its own override's, or with ?scopeKey= that scope key's.
  - min 0
- `GetQuota.response.200.window` (string | null, required) — rate quotas: PT1S to PT1H.
- `GetQuota.response.200.scopes` (array<object>, required) — Every scope key with an override or known usage, or only ?scopeKey=; for a perRegion quota, a row per region (or only ?region=). An organization-scoped quota's scope key is the organization.
  - `GetQuota.response.200.scopes.capacity` (integer | null, required)
    - min 0
  - `GetQuota.response.200.scopes.region` (string, required) — A region (us-west-1), or "" for what isn't regional.
    - pattern `^([a-z]{2}-[a-z]+-[0-9]+)?$`
  - `GetQuota.response.200.scopes.scopeKey` (string, required) — A lowercase UUID.
    - pattern `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`
  - `GetQuota.response.200.scopes.source` (unknown, required) — Which value applied: an override for the scope key, one for the whole organization, the tier's default, or the quota's default.
    - one of `"override"`, `"organizationOverride"`, `"tier"`, `"default"`
  - `GetQuota.response.200.scopes.tier` (string | null, required)
  - `GetQuota.response.200.scopes.usage` (object, required)
    - `GetQuota.response.200.scopes.usage.periodStart` (one of, required) — usage quotas only.
      - one of: `null`, [Instant](/quotas-api/schemas/Instant/)
    - `GetQuota.response.200.scopes.usage.resetsAt` (one of, required) — usage quotas only.
      - one of: `null`, [Instant](/quotas-api/schemas/Instant/)
    - `GetQuota.response.200.scopes.usage.state` (unknown, required) — unavailable: the product (allocation) or Quotas' Redis didn't answer in time; never a stale number.
      - one of `"available"`, `"unavailable"`
    - `GetQuota.response.200.scopes.usage.used` (integer | null, required) — allocation: in use; usage: this billing period; concurrency: in flight; rate: tokens in use of the bucket's capacity (capacity minus whole tokens available), never above capacity. null when unavailable.
      - min 0
  - `GetQuota.response.200.scopes.value` (integer, required)
    - min 0
- `GetQuota.response.200.usageAvailable` (boolean, required) — false when some usage couldn't be read: rows known only from the product's usage are then missing, and rows shown have usage unavailable.

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetQuota.response.400.error` (object, required)
  - `GetQuota.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetQuota.response.400.error.message` (string, required)
    - maxLength 1024
  - `GetQuota.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetQuota.response.400.error.issues.message` (string, required)
    - `GetQuota.response.400.error.issues.path` (string, required)
  - `GetQuota.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request (contracts/quotas.md, "When a quota is exceeded"). Never with Retry-After.
    - `GetQuota.response.400.error.quota.id` (string, required)
    - `GetQuota.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetQuota.response.400.error.quota.limit` (integer, required)
      - min 0
    - `GetQuota.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetQuota.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetQuota.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetQuota.response.400.error.quota.region` (string, optional)
    - `GetQuota.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetQuota.response.400.error.quota.scopeResourceName` (string, optional)
    - `GetQuota.response.400.error.quota.used` (integer, optional)
      - min 0
    - `GetQuota.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetQuota.response.401.error` (object, required)
  - `GetQuota.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetQuota.response.401.error.message` (string, required)
    - maxLength 1024
  - `GetQuota.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetQuota.response.401.error.issues.message` (string, required)
    - `GetQuota.response.401.error.issues.path` (string, required)
  - `GetQuota.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request (contracts/quotas.md, "When a quota is exceeded"). Never with Retry-After.
    - `GetQuota.response.401.error.quota.id` (string, required)
    - `GetQuota.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetQuota.response.401.error.quota.limit` (integer, required)
      - min 0
    - `GetQuota.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetQuota.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetQuota.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetQuota.response.401.error.quota.region` (string, optional)
    - `GetQuota.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetQuota.response.401.error.quota.scopeResourceName` (string, optional)
    - `GetQuota.response.401.error.quota.used` (integer, optional)
      - min 0
    - `GetQuota.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetQuota.response.403.error` (object, required)
  - `GetQuota.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetQuota.response.403.error.message` (string, required)
    - maxLength 1024
  - `GetQuota.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetQuota.response.403.error.issues.message` (string, required)
    - `GetQuota.response.403.error.issues.path` (string, required)
  - `GetQuota.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request (contracts/quotas.md, "When a quota is exceeded"). Never with Retry-After.
    - `GetQuota.response.403.error.quota.id` (string, required)
    - `GetQuota.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetQuota.response.403.error.quota.limit` (integer, required)
      - min 0
    - `GetQuota.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetQuota.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetQuota.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetQuota.response.403.error.quota.region` (string, optional)
    - `GetQuota.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetQuota.response.403.error.quota.scopeResourceName` (string, optional)
    - `GetQuota.response.403.error.quota.used` (integer, optional)
      - min 0
    - `GetQuota.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetQuota.response.404.error` (object, required)
  - `GetQuota.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetQuota.response.404.error.message` (string, required)
    - maxLength 1024
  - `GetQuota.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetQuota.response.404.error.issues.message` (string, required)
    - `GetQuota.response.404.error.issues.path` (string, required)
  - `GetQuota.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request (contracts/quotas.md, "When a quota is exceeded"). Never with Retry-After.
    - `GetQuota.response.404.error.quota.id` (string, required)
    - `GetQuota.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetQuota.response.404.error.quota.limit` (integer, required)
      - min 0
    - `GetQuota.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetQuota.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetQuota.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetQuota.response.404.error.quota.region` (string, optional)
    - `GetQuota.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetQuota.response.404.error.quota.scopeResourceName` (string, optional)
    - `GetQuota.response.404.error.quota.used` (integer, optional)
      - min 0
    - `GetQuota.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetQuota.response.429.error` (object, required)
  - `GetQuota.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetQuota.response.429.error.message` (string, required)
    - maxLength 1024
  - `GetQuota.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetQuota.response.429.error.issues.message` (string, required)
    - `GetQuota.response.429.error.issues.path` (string, required)
  - `GetQuota.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request (contracts/quotas.md, "When a quota is exceeded"). Never with Retry-After.
    - `GetQuota.response.429.error.quota.id` (string, required)
    - `GetQuota.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetQuota.response.429.error.quota.limit` (integer, required)
      - min 0
    - `GetQuota.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetQuota.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetQuota.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetQuota.response.429.error.quota.region` (string, optional)
    - `GetQuota.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetQuota.response.429.error.quota.scopeResourceName` (string, optional)
    - `GetQuota.response.429.error.quota.used` (integer, optional)
      - min 0
    - `GetQuota.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetQuota.response.500.error` (object, required)
  - `GetQuota.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetQuota.response.500.error.message` (string, required)
    - maxLength 1024
  - `GetQuota.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetQuota.response.500.error.issues.message` (string, required)
    - `GetQuota.response.500.error.issues.path` (string, required)
  - `GetQuota.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request (contracts/quotas.md, "When a quota is exceeded"). Never with Retry-After.
    - `GetQuota.response.500.error.quota.id` (string, required)
    - `GetQuota.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetQuota.response.500.error.quota.limit` (integer, required)
      - min 0
    - `GetQuota.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetQuota.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetQuota.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetQuota.response.500.error.quota.region` (string, optional)
    - `GetQuota.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetQuota.response.500.error.quota.scopeResourceName` (string, optional)
    - `GetQuota.response.500.error.quota.used` (integer, optional)
      - min 0
    - `GetQuota.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetQuota.response.503.error` (object, required)
  - `GetQuota.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetQuota.response.503.error.message` (string, required)
    - maxLength 1024
  - `GetQuota.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetQuota.response.503.error.issues.message` (string, required)
    - `GetQuota.response.503.error.issues.path` (string, required)
  - `GetQuota.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request (contracts/quotas.md, "When a quota is exceeded"). Never with Retry-After.
    - `GetQuota.response.503.error.quota.id` (string, required)
    - `GetQuota.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetQuota.response.503.error.quota.limit` (integer, required)
      - min 0
    - `GetQuota.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetQuota.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetQuota.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetQuota.response.503.error.quota.region` (string, optional)
    - `GetQuota.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetQuota.response.503.error.quota.scopeResourceName` (string, optional)
    - `GetQuota.response.503.error.quota.used` (integer, optional)
      - min 0
    - `GetQuota.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/quotas-api/GetQuota/index.md