Cabinetry.Online API v1.0 helps in viewing your job lists page and also helps you download specific job in a particular format.
The Cabinetry.Online API uses API keys to authenticate requests. You can view and manage your API keys in the Cabinetry.Online Settings page.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
The host for Cabinetry.Online API v1.0 requests is always https://cabinetry.online/api/
To authenticate, add an X-GC-API-KEY header to your API request that contains an API key.
GET https://cabinetry.online/api/jobs/{status}
X-GC-API-KEY: Your.API.Key-HERE| Verb | Description |
|---|---|
| GET | Retrieve a resource or group of resources |
Most GET resources allow for retrieval of information in batches and this will be noted in their documentation.
A few endpoints do not support pagination. These endpoints will silently ignore the pagination parameters.
Pagination parameters are specified as query parameters in the request URL:
GET https://cabinetry.online/api/{endpoint}?page={page}&limit={limit}
| Parameter | Type | Description | Default |
|---|---|---|---|
| page | integer | The page number to return | 1 |
| limit | integer | The number of records to return | 1000 |
The limit parameter cannot exceed 1000.
For example, a request with limit set to 20 and page set to 8 will return records 141-160.
Endpoints that support pagniation return the total number of records in a separate field in the response data.
{
"success": 1,
"data": [],
"total": {total}
}| Field | Type | Description |
|---|---|---|
| total | integer | Total number of records available |
Note: that if records are added to the data returned between subsequent requests, the total may change.
GET https://cabinetry.online/api/jobs/{status}?page=1&limit=25
{
"success": 1,
"data": /* ... */,
"total": "46"
}With the exception of a couple of endpoints where files of a specific data type are returned, all endpoints return a JSON object with a "success" key.
| Field | Type | Description |
|---|---|---|
| status | integer | 1 if the request was successful, 0 otherwise |
| error | string | Error message. Omitted if the request was successful |
Different endpoints will return data in different fields, however mostly data is returned in the data field and is an array of objects representing each row of data.
| HTTP status code | Meaning |
|---|---|
| 200 | Success, request was performed successfully |
| 400 | Invalid request, invalid or missing data in your request |
| 401 | Unauthorized access, invalid Api key |
| 403 | Forbidden, attempted to access or modify a resource you don't have access to |
| 404 | Not found, attempted to access or modify a resource that doesn't exist |
GET https://cabinetry.online/api/jobs/{status}?page=1&limit=25
{
"success": 1,
"data": /* ... */,
"total": "46"
}GET https://cabinetry.online/api/jobs/{status}?page=1&limit=25
{
"success": 0,
"error": "Missing parameter"
}See Webhooks.