Retrieve

GET 
https://api.ideal-postcodes.co.uk/v1/keys/:key/licensees/:licensee

Returns licensee information as identified by the licensee key.

Request

Path Parameters

key stringrequired
API Key
The API Key to retrieve. Begins ak_.
Example: ak_test
licensee stringrequired
Licensee Key
Uniquely identifies a licensee.
Example: sl_hk71kco54zGSGvF9eXXrvvnMOLLNh

Query Parameters

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

Responses

200

Success

Response Headers

application/json

Schema

Schema

result object

Licensee object which can be defined by user

namestringrequired

Licensee individual or organisation name

Example: Qwerty Widgets Limited

addressstringrequired

Licensee's first, second and third line address as well as post town concatenated by commas

Example: 12 High Street, Manchester

postcodestringrequired

Licensee's postcode

Example: ID1 1QD

whiteliststring[]required

A list of allowed URLs. An empty list means that whitelisting is disabled

daily objectrequired

limitint32nullable

The maximum number of lookups this licensee can perform in a day. null indicates the limit is not active

Possible values: >= 0

Example: 10000

countint32required

The number lookups performed by the licensee on the day represented b licesees.daily.updatedAt

Possible values: >= 0

Example: 232

updatedAtstringrequired

The timestamp when the limit was last used.

Example: 2016-08-05T16:43:28.865Z

idstringrequired

An immutable ID provided for every licensee. Primarily used for paginated list requests.

Example: 56a11209ebe230380bf104c3

keystringrequired

Uniquely identifies a licensee for a key.

Required to perform paid lookups for a specific licensee. Typically begins sk_.

Example: sl_ijoiqsxeQgXW2gkiE0X94

createdAtstringrequired

Timestamp for when the licensee was created

Example: 2016-01-21T17:14:49.971Z

codeint32required

Possible values: [2000]

messagestringrequired

Possible values: [Success]

Example (auto)

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

400

Bad Request

application/json

Schema

Schema

codeint32required
400X type error response code
messagestringrequired
Bad request error description
errors object[]
Array [
messagestringrequired
Indicates location of error in request query or URL parameter
Example: should have required property 'type'
pathstringrequired
Indicates location of error in request query or URL parameter
Example: .query.type
errorCodestring
Example: required.openapi.validation
]

Example (auto)

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

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.ideal-postcodes.co.uk/v1/keys/:key/licensees/:licensee");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.ideal-postcodes.co.uk/v1

Parameters

key — pathrequired

licensee — pathrequired

user_token — query

ResponseClear

Click the Send API Request button above and see the response here!