Sign in

v7

latestOpenAPI 3.1.02026-08-051856761.1 MB
benefit-grants
public

List Benefit Grants

List benefit grants across all benefits accessible to the authenticated subject.

Scopes: benefits:read benefits:write

get/v1/benefit-grants/

Query parameters

string uuid4

The organization ID.

OR
string[]
Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737

Filter by organization ID.

string uuid4

The customer ID.

OR
string[]

Filter by customer ID.

string

The customer external ID.

OR
string[]

Filter by customer external ID.

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.

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.

sortingBenefitGrantSortProperty[] nullable

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Response

Successful Response