v50

latestOpenAPI 3.0.3AGPLv3raw.githubusercontent.com2026-04-1028178439.6 KB
Licensees

List

Returns a list of licensees for a key.

get/keys/{key}/licensees

Path parameters

keystring required

API Key

The API Key to retrieve. Begins ak_.

Query parameters

starting_afterinteger

Specify ID of the licensee after which you would like to list results

user_tokenstring

Private User Token

A secret key used for sensitive operations on your account and API Keys.

Your user token can be retrieved and managed from your accounts page.

Typically beings uk_...

limitinteger

Limit

Specifies the maximum number of records to retrieve.

By default the limit is 10. Requesting a larger result set will result in more latency

querystring

Filter result by licensee name. Query can be shortened to q=

Response

Success

message'Success' required
code2000 required

Example response

{
  "result": {
    "licensees": [
      {
        "name": "Qwerty Widgets Limited",
        "address": "12 High Street, Manchester",
        "postcode": "ID1 1QD",
        "whitelist": [
          "https://www.example.com"
        ],
        "daily": {
          "limit": 10000,
          "count": 232,
          "updatedAt": "2016-08-05T16:43:28.865Z"
        },
        "id": "56a11209ebe230380bf104c3",
        "key": "sl_ijoiqsxeQgXW2gkiE0X94",
        "createdAt": "2016-01-21T17:14:49.971Z"
      }
    ]
  }
}