List account grants

Admin API reference

v4 API

List account grants

Request

Retrieves a list of account grants.

Security

ZephrHmacHttp

Path

accountIdstringrequired

Unique Account identifier

cURL

curl -i -X GET \
  'https://demo.api.zephr.com/v3/accounts/{accountId}/grants' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

Headers

any

Bodyapplication/json

Array [

grantIdstring

Example:"e196ad75-a6d0-471b-90b3-de3843dd7860"

user_idstring

Example:"e1812285-2f21-441e-8be4-b08835cd4b2c"

account_idstring

Example:"14515649-565f-4b1c-8346-eb98301c1d6b"

expiry_statestring

Enum:"pending""active""expired"

entitlement_typestringrequired

An enum describing the type of the entitlement.

Enum:"bundle""entitlement""meter""credits"

entitlement_idstringrequired

Example:"b74df5c4-fded-492c-ad90-07646bded5db"

startTimestring

Example:"2022-06-01 00:00:00"

endTimestring

Example:"2022-12-31 23:59:59"

product_idstringrequired

Example:"86abb44a-e6f2-4f9b-ac26-46ae0a13ed31"

createdAtstring

Example:"2022-05-31 23:59:59"

]

Response

[
  {
    "grantId": "e196ad75-a6d0-471b-90b3-de3843dd7860",
    "user_id": "e1812285-2f21-441e-8be4-b08835cd4b2c",
    "account_id": "14515649-565f-4b1c-8346-eb98301c1d6b",
    "expiry_state": "pending",
    "entitlement_type": "bundle",
    "entitlement_id": "b74df5c4-fded-492c-ad90-07646bded5db",
    "startTime": "2022-06-01 00:00:00",
    "endTime": "2022-12-31 23:59:59",
    "product_id": "86abb44a-e6f2-4f9b-ac26-46ae0a13ed31",
    "createdAt": "2022-05-31 23:59:59"
  }
]