Skip to main content
GET
List Benefit Grants

Authorizations

Authorization
string
header
required

Authentication: You can generate a Personal Access Token from your settings.

Path Parameters

id
string<uuid4>
required

Identifier of the benefit.

Query Parameters

is_granted
boolean | null

Return only records matching granted status. If true, only granted benefits will be returned. If false, only revoked benefits will be returned..

customer_id

Return only records matching customer. Identifier of the customer.

member_id

Return only records matching member.

page
integer
default:1

Results page to return. The first page is used by default.

limit
integer
default:10

Records returned per page. Defaults to 10 and accepts up to 100.

Response

Request completed successfully

items
BenefitGrant · object[]
required
pagination
Pagination · object
required