POpolar
benefits
public

List Benefit Grants

Changed on

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

Request

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

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.

string uuid4

The customer ID.

OR
string[]
string uuid4
OR
string[]
pageinteger

Page number, defaults to 1.

limitinteger

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

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