Lists bundle grants on the entitlement with pagination, sorting, and filtering.

GET

/api/v1/provision/admin/entitlements/{entitlementId}/bundle-grants

curl --request GET \
  --url 'https://example.com/api/v1/provision/admin/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/bundle-grants?pageNumber=1&pageSize=100'

Parameters

Path Parameters

entitlementId

required

string format: uuid

Entitlement id.

Query Parameters

pageNumber

integer | string format: int32

default: 1 /^-?(?:0|[1-9]\d*)$/

pageSize

integer | string format: int32

default: 100 /^-?(?:0|[1-9]\d*)$/

sortOrder

string

filter

string

Responses

200

OK

object

pageNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

pageSize

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

totalCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

items

Array<object>

object

id

string format: uuid

bundleId

string format: uuid

bundleCode

string

bundleName

string

usagePlanSetId

string format: uuid

usagePlanSetName

string

startsAt

string format: date-time

expiresAt

null | string format: date-time

isRevoked

boolean

revokedAt

null | string format: date-time

reference

null | string

isActive

boolean

totalPages

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasPreviousPage

boolean

hasNextPage

boolean

object

pageNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

pageSize

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

totalCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

items

Array<object>

object

id

string format: uuid

bundleId

string format: uuid

bundleCode

string

bundleName

string

usagePlanSetId

string format: uuid

usagePlanSetName

string

startsAt

string format: date-time

expiresAt

null | string format: date-time

isRevoked

boolean

revokedAt

null | string format: date-time

reference

null | string

isActive

boolean

totalPages

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasPreviousPage

boolean

hasNextPage

boolean

Example ^generated

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalCount": 1,
  "items": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "bundleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "bundleCode": "example",
      "bundleName": "example",
      "usagePlanSetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "usagePlanSetName": "example",
      "startsAt": "2026-04-15T12:00:00Z",
      "expiresAt": "2026-04-15T12:00:00Z",
      "isRevoked": true,
      "revokedAt": "2026-04-15T12:00:00Z",
      "reference": "example",
      "isActive": true
    }
  ],
  "totalPages": 1,
  "hasPreviousPage": true,
  "hasNextPage": true
}

object

pageNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

pageSize

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

totalCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

items

Array<object>

object

id

string format: uuid

bundleId

string format: uuid

bundleCode

string

bundleName

string

usagePlanSetId

string format: uuid

usagePlanSetName

string

startsAt

string format: date-time

expiresAt

null | string format: date-time

isRevoked

boolean

revokedAt

null | string format: date-time

reference

null | string

isActive

boolean

totalPages

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasPreviousPage

boolean

hasNextPage

boolean

Example ^generated

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalCount": 1,
  "items": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "bundleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "bundleCode": "example",
      "bundleName": "example",
      "usagePlanSetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "usagePlanSetName": "example",
      "startsAt": "2026-04-15T12:00:00Z",
      "expiresAt": "2026-04-15T12:00:00Z",
      "isRevoked": true,
      "revokedAt": "2026-04-15T12:00:00Z",
      "reference": "example",
      "isActive": true
    }
  ],
  "totalPages": 1,
  "hasPreviousPage": true,
  "hasNextPage": true
}

404

Not Found

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}