Retrieve an access licence by id.
GET https://api.ft.com/licence/{licenceId}
For security reasons requests must be made over HTTPS.
Path param | Mandatory | Value |
---|---|---|
licenceId |
Yes | The unique identifier for the licence which is to be retrieved |
Header | Value |
---|---|
X-Api-Key | <API key value> |
Not supported.
{ "id": "a0827838-3c28-4a80-a14e-5782001b6f7b", "creationDateTime": "2015-08-14T10:57:13.339Z", "products": [ { "code": "P1", "name": "FT.com Standard" } ], "issueReason": "Contract Signed", "links": [ { "rel": "contract", "href": "http://not-supported.ft.com", "id": "FT-13990275" } ], "status": "active", "href": "/licences/a0827838-3c28-4a80-a14e-5782001b6f7b", "seatsHref": [ { "rel": "seats", "href": "/licences/a0827838-3c28-4a80-a14e-5782001b6f7b/seats" } ], "seatLimit": 100, "ipAccessEnabled": true, "ipAccessAddresses": [ "127.0.0.1-12" ], "adminsHref": [ { "rel": "administrators", "href": "/licences/06211a11-8093-4da1-97eb-8ec3fc9b44b6/administrators" } ] }
{ "message": "6821f0bf-654e-48de-8b4f-919e4166400e6667777777777 is not a valid AccessLicenceId." }
Http Status | Description |
---|---|
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 |
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.