List Benefit Grants
Intent
Reads the available benefit grants as a pageable collection without changing them.
When to call it
Call this when an interface, sync, or support workflow needs to inspect benefit grants. Use the filters and paging controls shown below to limit the result.
Access boundary
Authorize the request with a token that carries benefits:read or benefits:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Authorizations
Path Parameters
Identifier of the benefit.
Query Parameters
Return only records matching granted status. If true, only granted benefits will be returned. If false, only revoked benefits will be returned..
Return only records matching customer. Identifier of the customer.
Return only records matching member.
Results page to return. The first page is used by default.
Records returned per page. Defaults to 10 and accepts up to 100.