List

GET 
/keys/:key/licensees

Returns a list of licensees for a key.

Request

Path Parameters

key stringrequired
API Key
The API Key to retrieve. Begins ak_.
Example: ak_test

Query Parameters

starting_after int32

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

user_token string
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_...
Example: uk_B59ScW1p1HHouf1VqclEPZUx
limit int32
Possible values: >= 1 and <= 100
Default value: 10
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
Example: 5
query string

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

Responses

200

Success

application/json

Schema

Schema

result objectrequired

List of licensees

licensees object[]

hasMore boolean

Returns true if there are more licensees listed after the maximum number of results as implied by limit

message stringrequired

Possible values: [Success]

code int32required

Possible values: [2000]

Example (from schema)

{
  "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"
      }
    ],
    "hasMore": true
  },
  "message": "Success",
  "code": 2000
}

400

Bad Request

application/json

Schema

Schema

code int32required

API Response Code. Non 2xxx code indicates a failure. This code will provide a more specific reason when a failure occurs and facilitates debugging.

message stringrequired

Human readable error message supplied with every error response.

errors object[]
Array [
message stringrequired
Indicates location of error in request query or URL parameter
path stringrequired
Indicates location of error in request query or URL parameter
errorCode string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    {
      "message": "should have required property 'type'",
      "path": ".query.type",
      "errorCode": "required.openapi.validation"
    }
  ]
}

Loading...