Benefits
List Benefit Grants
List the individual grants for a benefit.
It’s especially useful to check if a user has been granted a benefit.
Scopes: benefits:read
benefits:write
GET
Authorizations
You can generate an Organization Access Token from your organization's settings.
Path Parameters
The benefit ID.
Query Parameters
Filter by granted status. If true
, only granted benefits will be returned. If false
, only revoked benefits will be returned.
Filter by customer.
Page number, defaults to 1.
Required range:
x > 0
Size of a page, defaults to 10. Maximum is 100.
Required range:
x > 0
Response
200
application/json
Successful Response
The response is of type object
.