Library List Endpoint
- John Seguin
The Library List Endpoint is designed to facilitate the integration of the LibKey API into host settings where the affiliation of the client is not known but whereby the client wants to present for the user browsable/searchable list of subscribing LibKey organizations by selecting an organization the host can know the Library ID of the selected organization.
Contact Third Iron Support to Request your API Key
Email us at support@thirdiron.com to request your API Key. The Third Iron API can only be used by institutions subscribing to the Third Iron Complete and LibKey Service.
There are two types of API Key’s available:
Individual Library - A key to be used (and only authorized) for a subscribing institution.
Integration Partner - This “Universal” key can be used to access any subscribing Library ID with a single API Key and is required for using the Library List Endpoint. Please contact support@thirdiron.com for more details!
Submit a GET request against this endpoint with and get returned a json array of matching organizations and library ID’s.
Third Iron Library List Endpoint:
Supported Methods |
GET
|
|---|---|
Endpoint Location | /public/v1/libraries?filter[libkey_subscription_status]=active,trial
|
Library List Response:
The Library List will respond with a JSON array of all libraries along with their library ID.
Response Object:
Property | Type | Description |
|---|---|---|
data | Object | A list of libraries will be returned that are active and in trial with privileges to use LibKey. |
Full List of Properties Returned
Property | Type | Description | Optional |
|---|---|---|---|
id | number | The library ID | No |
name | string | The name of the library | No |
type | string | has the value “libraries” | No |
Example Request
/public/v1/libraries?filter[libkey_subscription_status]=active,trial&access_token=xxxxxxxxxx
Example abbreviated response: