Developers
API referenceBusiness sign in

Locations

One point or locker

GET/locations/{code}

Scope locations.read

Public projection of one active point or live locker: opening state, space level, what it accepts, size limits, Relay coverage and closures in the next 30 days. Hubs and inactive points return 404.

Request

Path parameters

Path parameters
NameInTypeDescription
codeRequiredpathstringLocation public code.Pattern ^[A-Za-z0-9-]{4,40}$

Response

Success responses
StatusMeaning
200The location

The body is { "status": "success", "data": … }. Fields of data (LocationDetailResult):

Response data
FieldTypeDescription
locationRequiredLocationDetail
generatedAtOptionalstring (date-time)

Errors

Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.

Error responses
StatusWhen
401Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked.
403The key lacks the scope, or the operation needs a LIVE key. The key lacks the scope, or this call needs a LIVE key (LIVE_KEY_REQUIRED), or the Business owner is not verified (SENDER_VERIFICATION_REQUIRED).
404Not found for this Business and environment. IDs from another Business or environment are always 404. Not found for this Business and environment. IDs from another Business or the other environment are always 404.
429Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key.