API ReferenceLocations

Get Location

Returns a single location by ID. Returns 404 if the ID belongs to a job — use GET /jobs/{id} for jobs.

Requires scope: locations:read

Authentication

API_KEYstring
API Key authentication via header

Path parameters

idUUIDRequired
Location ID.

Response

This endpoint returns an object.
idUUID
Unique identifier for the location.
namestring
Display name of the location.
createdAtdatetime
ISO 8601 timestamp when the record was created.
updatedAtdatetime
ISO 8601 timestamp when the record was last updated.
typeenum
Location type code.
locationTypestring

Human-readable label for the location type.

plateNumberstring
Vehicle plate number, if the location is a vehicle.
numberstring
Internal reference number or identifier for the location.
addressobject
Physical address of the location.
archivedboolean
Whether the location has been archived.
activeboolean
Whether the location is currently active.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error