This endpoint allows clients to retrieve seat holders for a given licenceId, and requires both an API key based authentication and OAuth access token based authorisation, via the API Authorisation Service to access.
GET https://api.ft.com/licence-seat-holders/{licenceId}
For security reasons requests must be made over HTTPS.
| Header | Value |
|---|---|
| X-Api-Key | <API key value> |
| Authorization |
Bearer <Access token> where <Access token> is as retrieved via the API Authorisation Service for a licence administrator of the licence in question. To see seatholder details, the access token must have scope <licence_data> |
| Path param | Mandatory | Value |
|---|---|---|
| licenceId |
Yes | The unique identifier for the licence which is to be retrieved |
| Query param | Mandatory | Value |
|---|---|---|
| limit |
no (default = 50) | Limit of results per page (number <= 50000) |
| offset | no | The offset offset into a resource collection, 0 is the first item of a collection |
| order | no (default = asc) | Result sort order. One of (asc, desc) |
| orderby | no (default = lastName) | Sorting by column. One of (lastName, firstName, email, joinedDate) |
| q | no | Filter query to filter users |
| Header | Value |
|---|---|
| X-Api-Key | <API key value> |
Not supported.
{
“offset”: 0,
“limit”: 999,
“returnedResourceCount”: 2,
“totalResourceCount”: 2,
“seatHolders”: [
{
“id”: “93cc27c9-d7fa-4a70-a5b5-e54e0fe9c720”,
“lastName”: “Crump”,
“firstName”: “Mercedez”,
“email”: “mercedez.crump931@ftqa.org”,
“joinedDate”: “2015-10-02T15:06:03.786Z”
},
{
“id”: “9bc86274-8aa8-48be-9381-acb664d8b5de”,
“lastName”: “Daily”,
“firstName”: “Josephina”,
“email”: “josephina.daily564@ftqa.org”,
“joinedDate”: “2015-10-02T15:06:04.061Z”
}
]
}
{
“code”: 400,
“code_name”: “BAD_REQUEST”,
“message”: “accessLicenceId cannot be null”
}
| Http Status | Description |
|---|---|
| 200 Ok | A list of seat holders is returned |
| 400 Bad request | The request was invalid. You may refer to response for details around why the request was invalid |
| 403 Forbidden | Invalid API key used |
| 404 Not Found | No licence exists for the licenceId provided |
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.