/api/v1/public/locations
Return locations
Returns the active locations configured for the account, ordered by name. Takes no parameters.
operationId Return locations
Respuestas
200 Every active location, ordered by name.
Encabezados de respuesta
| Nombre | Tipo | Descripción |
|---|---|---|
X-RateLimit-Limit |
integer | Your hourly allowance. |
X-RateLimit-Remaining |
integer | Requests left in the current window. |
X-RateLimit-Reset |
integer | When the window resets, as an absolute Unix epoch time in seconds — not a countdown. |
Cuerpo de application/json
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
error
|
boolean | obligatorio | Always `false` on a successful response. Authentication and rate-limit failures instead return a string error code in this field. |
data
|
array | obligatorio | The full, unpaginated list. |
id
|
string (uuid) | obligatorio | Location identifier. |
name
|
string | obligatorio | Location name. |
created_at
|
string (date-time) | obligatorio | When the location was created. |
Ejemplo
{
"error": false,
"data": [
{
"id": "7c04…",
"name": "Plant A",
"created_at": "2026-01-09T09:00:00.000Z"
}
]
}
401 `API_KEY_REQUIRED` — the `Authorization: Bearer kcs_…` header is missing or malformed. `API_KEY_INVALID` — the key is unknown, revoked, or expired.
403 `INSUFFICIENT_SCOPE` — the key's scope does not permit this method. `FEATURE_NOT_AVAILABLE` — the account's plan does not include API access.
429 `RATE_LIMIT_EXCEEDED` — the hourly limit was reached. Read `Retry-After` (seconds); `X-RateLimit-Reset` is not set on a 429.
Encabezados de respuesta
| Nombre | Tipo | Descripción |
|---|---|---|
Retry-After |
integer | Seconds to wait before retrying. |
500 Unexpected server error.