zenly/Documentation
Search documentation
English
API referenceLocations

List locations

GET/v1/locations

Every location the organization has, open or closed. Not paginated: the count is bounded by the subscription tier. These ids are what the rest of the API means by locationId.

Authorization

Any active key, sent as a bearer token. Keys are owner-equivalent, so there are no scopes to grant and nothing to configure per endpoint. See Authentication.

Parameters

None. There is nothing to put in the path or query.

Response fields
dataarray of LocationBody
5 fields per item
addressstringOPTIONAL
idstring
namestring
statusstring (enum)
timezonestring

IANA name. Sessions at this location are scheduled on this clock.

totalinteger (int64)

Rows returned. This endpoint is not paginated, so it is the whole set.

Errors

These apply to every endpoint on the API, not just this one. Errors covers the body shape.

401
Unauthorized

No bearer token, or a token that is unknown, revoked or expired. All four answer identically on purpose, so a caller probing tokens learns nothing about which is which.

402
Payment Required

The organization’s plan does not include the public API. It is available on Pro and above, and the check runs on every request, so a downgrade stops keys that were minted earlier.

403
Forbidden

The organization is not active.

429
Too Many Requests

The key is over its rate limit. Back off and retry.

500
Internal Server Error

Something failed on our side. The body carries a short sentence and never an internal error string, so quote your own request timestamp when reporting one.

stays in this tab
cURL
curl "https://api.zenly.app.br/v1/locations" \
  -H "Authorization: Bearer $ZENLY_API_KEY"
Response200 OK
{
  "data": [
    {
      "address": "string",
      "id": "string",
      "name": "string",
      "status": "active",
      "timezone": "string"
    }
  ],
  "total": 0
}