List

get

https://restapi.ordergroove.com/entitlements/

List entitlements associated to merchant's customers. Only relevant for merchants offering digital products.

Query Params

merchant

string

required

Merchant ID

merchant_user_id

string

Customer ID. If the request is made on behalf of a customer, only the entitlements tied to the calling customer are returned, regardless of the value provided in this field

resource_public_id

string

Resource ID

external_resource_id

string

Merchant resource ID

live

boolean

Filters entitlements by whether their associated resources are accessible

resource_name

string

Filters entitlements by resource name (case-insensitive match).

grantee_external_ids_exact

string

Filter entitlements by list of exact ids (returns entitlement if and only if every grantee passed in is present in the entitlement and no other grantees are present) example: grantee_external_ids_exact=grantee_a,grantee_b returns entitlements with both grantee_a and grantee_b, but not entitlements with just grantee_a or entitlements that have grantee_a, grantee_b, but also grantee_c

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200200

403403