Sign in

v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB
Entitlements

List grants

List all grants for all the subjects and entitlements. This endpoint is intended for administrative purposes only. To fetch the grants of a specific entitlement please use the /api/v1/subjects/{subjectKeyOrID}/entitlements/{entitlementOrFeatureID}/grants endpoint. If page is provided that takes precedence and the paginated response is returned.

⚠️ Deprecated: Use GET /api/v2/grants instead.

get/api/v1/grants

Query parameters

featurestring[]

Filtering by multiple features.

Usage: ?feature=feature-1&feature=feature-2

subjectstring[]

Filtering by multiple subjects.

Usage: ?subject=customer-1&subject=customer-2

includeDeletedboolean

Include deleted

pageinteger

Page index.

Default is 1.

pageSizeinteger

The maximum number of items per page.

Default is 100.

offsetinteger

Number of items to skip.

Default is 0.

limitinteger

Number of items to return.

Default is 100.

order'ASC' | 'DESC'

The order direction.

The order direction.

orderBy'id' | 'createdAt' | 'updatedAt'

Order by options for grants.

The order by field.

Response

The request has succeeded.

OR

Example response

[
  {
    "createdAt": "2024-01-01T01:01:01.001Z",
    "updatedAt": "2024-01-01T01:01:01.001Z",
    "deletedAt": "2024-01-01T01:01:01.001Z",
    "amount": 100,
    "priority": 1,
    "effectiveAt": "2023-01-01T01:01:01.001Z",
    "expiration": {
      "count": 12
    },
    "maxRolloverAmount": 100,
    "minRolloverAmount": 100,
    "metadata": {
      "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
    },
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "entitlementId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "nextRecurrence": "2023-01-01T01:01:01.001Z",
    "expiresAt": "2023-01-01T01:01:01.001Z",
    "voidedAt": "2023-01-01T01:01:01.001Z",
    "recurrence": {
      "interval": "DAY",
      "intervalISO": "P1D",
      "anchor": "2023-01-01T01:01:01.001Z"
    },
    "annotations": {
      "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
    }
  }
]