v6

OpenAPI 3.1.02026-07-311856741.1 MB
benefits
public

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/v1/benefits/{id}/grants

Path parameters

idstring uuid4 required

The benefit ID.

Query parameters

is_grantedboolean nullable

Filter by granted status. If true, only granted benefits will be returned. If false, only revoked benefits will be returned.

Filter by granted status. If true, only granted benefits will be returned. If false, only revoked benefits will be returned.

string uuid4

The customer ID.

OR
string[]

Filter by customer.

string uuid4
OR
string[]

Filter by member.

pageinteger

Page number, defaults to 1.

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

Size of a page, defaults to 10. Maximum is 100.

Response

Successful Response