GET /licences

Find collection of licences by userId, adminUserId or retrieve all.

Request

Resource URL

GET https://api.ft.com/licences

For security reasons requests must be made over HTTPS.

Parameters

Query paramMandatoryValue
userid
No The unique identifier for the user whose licence is to be retrieved
adminuserid No The unique identifier for the admin user of the licence to be retrieved

Request Headers

HeaderValue
X-Api-Key <API key value>

Request Body

Not supported.

Response

HTTP Status Codes

Http StatusDescription
200 Ok A (wrapped) collection of licences is returned
400 Bad request The request was invalid. You may refer to response for details around why the request was invalid
401 Unauthorized Inalid access token used
403 Forbidden Invalid API key used

200 Ok - A (wrapped) collection of licences is returned

Returns a collection of Access Licences Resources in the response body. Note that some fields may be null depending on the granted scope contained in the access token.

400 Bad request - The request was invalid 

An error response will be returned with data describing the cause of the error.

401 Unauthorized - Invalid access token

The endpoint requires an access_token to authorize the request. The access_token supplied was invalid.

403 Forbidden - Your access to the API endpoint was denied

Make sure you are using a valid API key. If you are sure your are using a valid API key and problems persist, contact us for assistance.