GET catalogs
Retrieves all catalogs.
⚠️ Internal use
This is for internal use only!
Resource URL
https://www.drillster.com/api/2.1.1/catalogs
Parameters
| Field | Type | Description |
|---|---|---|
queryoptional |
String | An optional query to filter by catalog name or description. If no query is given, all catalogs are returned. |
resultFromoptional |
String | The ID of the last element from the previous page as quoted in the 2.1.1 Pagination object. Use this parameter, in combination with resultSize, to apply pagination of the result; it will limit the number of catalogs included in the result. If it is not specified, the first page will be displayed. |
resultSizeoptional |
Integer | The maximum number of catalogs to include in the result. If not specified, at most 10 catalogs are returned. |
Response
A 2.1.1 Catalogs object.
Error responses
The following error situations are possible:
| ID | Response code | Description |
|---|---|---|
not_authorized |
400 (Bad request) | The calling user is lacking the appropriate permission. |
catalog_not_found |
404 (Not found) | The specified catalog was not found. |
not_linked_to_organization |
401 (Unauthorized) | Caller is not linked to an organization. |
not_permitted |
403 (Forbidden) | Only the own organization is accessible. |