Documentation

Developers

IntroductionAuthentication

Featured Endpoints

Checkouts

Customer Portal

Customer-Sessions

Customers

Discounts

License Keys

List License KeysGET
Get License KeyGET
Update License KeyPATCH
Get ActivationGET

Oauth2

Organizations

Products

Issue Funding Endpoints

External Organizations

Repositories

Other Endpoints

Advertisements

Benefits

Checkout-Links

Checkouts

Custom-Fields

Customer Portal

Files

Metrics

Oauth2

Orders

Subscriptions

license_keys

List License Keys

get
/v1/license-keys
Get license keys connected to the given organization & filters.
Methods
OpenID Connect
Personal Access Token
Subjects
Organization
User
Scopes
license_keys:read
license_keys:write
Filter by organization ID.
Filter by benefit ID.
pagequery ParameterintegerDefault: 1Optional
Page number, defaults to 1.
Size of a page, defaults to 10. Maximum is 100.
Successful Response
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
The benefit ID.
max_pageinteger
curl -X GET \
    'https://api.polar.sh/v1/license-keys' \
    -H "Accept: application/json" \
    -H "Authorization: Bearer <token>" \
Responses
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "organization_id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "user": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "string",
        "public_name": "string",
        "avatar_url": "string"
      },
      "customer": {
        "created_at": "2024-12-20T00:00:00.000Z",
        "modified_at": "2024-12-20T00:00:00.000Z",
        "id": "00000000-0000-0000-0000-000000000000",
        "metadata": {},
        "email": "string",
        "email_verified": false,
        "name": "string",
        "billing_address": {
          "line1": "string",
          "line2": "string",
          "postal_code": "string",
          "city": "string",
          "state": "string",
          "country": "string"
        },
        "tax_id": [
          "string",
          "ad_nrt"
        ],
        "organization_id": "00000000-0000-0000-0000-000000000000",
        "avatar_url": "string"
      },
      "benefit_id": "00000000-0000-0000-0000-000000000000",
      "key": "string",
      "display_key": "string",
      "status": "granted",
      "limit_activations": 0,
      "usage": 0,
      "limit_usage": 0,
      "validations": 0,
      "last_validated_at": "2024-12-20T00:00:00.000Z",
      "expires_at": "2024-12-20T00:00:00.000Z"
    }
  ],
  "pagination": {
    "total_count": 0,
    "max_page": 0
  }
}