Licensees
List
Returns a key's licensees, oldest first, up to 100 per request. The list omits canceled licensees. The key must be enabled for sub-licensing.
get/keys/{key}/licensees
Request
- Base URL: https://api.addresszen.com/v1
- URL: https://api.addresszen.com/v1/keys/{key}/licensees
- Auth: HTTP bearer
Path parameters
keystring required
API Key
The API Key to retrieve. Begins ak_.
Query parameters
starting_afterinteger
ID of the licensee after which to list results
user_tokenstring
Management Key
A secret key used to manage your account and API Keys. It was previously called the user token.
Your management key can be retrieved and managed from your accounts page.
Typically begins uk_.... Prefer the Authorization: Bearer uk_... header.
limitinteger
Limit
Specifies the maximum number of records to retrieve.
By default the limit is 10. Requesting a larger result set adds latency.
querystring
Filter results by licensee name. Can be shortened to q=
Response
Success
Example response
{
"result": {
"licensees": [
{
"name": "Qwerty Widgets Limited",
"address": "12 High Street, Manchester",
"postcode": "BR8 7RE",
"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"
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.