Sign in

v51

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

List all entitlements

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

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

get/api/v1/entitlements

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

entitlementTypeEntitlementType[]

Filtering by multiple entitlement types.

Usage: ?entitlementType=metered&entitlementType=boolean

excludeInactiveboolean

Exclude inactive entitlements in the response (those scheduled for later or earlier)

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'createdAt' | 'updatedAt'

Order by options for entitlements.

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",
    "metadata": {
      "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
    },
    "activeFrom": "2023-01-01T01:01:01.001Z",
    "activeTo": "2023-01-01T01:01:01.001Z",
    "annotations": {
      "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
    },
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "subjectKey": "customer-1",
    "featureKey": "example-feature-key",
    "featureId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "lastReset": "2023-01-01T01:01:01.001Z",
    "currentUsagePeriod": {
      "from": "2023-01-01T01:01:01.001Z",
      "to": "2023-02-01T01:01:01.001Z"
    },
    "measureUsageFrom": "2023-01-01T01:01:01.001Z",
    "usagePeriod": {
      "interval": "DAY",
      "intervalISO": "P1D",
      "anchor": "2023-01-01T01:01:01.001Z"
    }
  }
]