POpolar
benefits
public

List Benefits

List benefits.

Scopes: benefits:read benefits:write

get/v1/benefits/

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/benefits/
  • 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
'custom' | 'discord' | 'github_repository' | 'downloadables' | 'license_keys' | 'meter_credit' | 'feature_flag' | 'slack_shared_channel'
OR
BenefitType[]
string uuid4

The benefit ID.

OR
string[]
string uuid4

The benefit ID.

OR
string[]
querystring nullable

Filter by description.

pageinteger

Page number, defaults to 1.

limitinteger

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

sortingBenefitSortProperty[] 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.

metadataMetadataQuery nullable

Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.

Response

Successful Response

Example response

{
  "items": [
    {
      "properties": {
        "repository_owner": "polarsource",
        "repository_name": "private_repo"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 11 revisions of this API.