---
title: "List"
method: GET
path: "/keys/{key}/licensees"
tags: ["Licensees"]
---

# List

`GET /keys/{key}/licensees`

## Request

- Base URL: `https://api.addresszen.com/v1`
- URL: `https://api.addresszen.com/v1/keys/{key}/licensees`
- Auth: HTTP bearer

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.

## Path parameters

- `key` string, required

## Query parameters

- `starting_after` integer
- `user_token` string
- `limit` integer
- `query` string

## Response `200`

Success

- LicenseesResponse
  - `result` object, required: List of licensees
    - `licensees` Licensee[]
      - `name` string, required: Licensee individual or organisation name
      - `address` string, required: Licensee's first, second and third line address as well as post town concatenated by commas
      - `postcode` string, required: Licensee's postcode
      - `whitelist` string[], required: A list of allowed URLs. An empty list disables the check. A request is allowed when its `Origin` or `Referer` header matches an entry. Use one of these formats: - `https://www.example.com` allows one site. Scheme and host must match - `*.example.com` allows the domain and all its subdomains
      - `daily` object, required
        - `limit` number, nullable: The maximum number of lookups this licensee can perform in a day. `null` indicates the limit is not active
        - `count` number, required: The number of lookups performed by the licensee on the day represented by `licensees.daily.updatedAt`
        - `updatedAt` string, required: The timestamp when the limit was last used.
      - `id` string, required: An immutable ID provided for every licensee. Primarily used for paginated list requests.
      - `key` string, required: Uniquely identifies a licensee for a key. Required to perform paid lookups for a specific licensee. Typically begins `sl_`.
      - `createdAt` string, required: Timestamp for when the licensee was created
    - `hasMore` boolean: Returns true if there are more licensees listed after the maximum number of results as implied by `limit`
  - `message` 'Success', required
  - `code` 2000, required

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/addresszen/apis/api-reference.md) · [All operations](https://skmtc.dev/addresszen/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc.dev/addresszen/apis/api-reference/revisions/cac119db15c0?raw)