POpolar
benefit-grants
public

List Benefit Grants

Changed on

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

Scopes: benefits:read benefits:write

get/v1/benefit-grants/

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/benefit-grants/
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: benefits:read, benefits:write)
    • or HTTP bearer
    • or HTTP bearer

Query parameters

string uuid4

The organization ID.

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

The customer ID.

OR
string[]
string

The customer external ID.

OR
string[]
is_grantedboolean nullable

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.

limitinteger

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.

Response

Successful Response

Changes

  • f9688fd328d6Revision changes
    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status