List locations

GET/locations

Lists the locations deals can be tagged with, by label. These are the organisation's own locations, or the platform's default locations when the organisation has set up none. A client organisation sees its parent's locations. Search the label with filter[q]. Use GET /locations/{id} for one location. Locations are set up in the platform, not through the API.

Query parameters

limitinteger#
Page size (1–100). Defaults to 25; values are clamped to the range.
Default: 25
cursorstring#
Opaque pagination cursor taken from a prior response's meta.next_cursor.
fieldsstring#
Comma-separated top-level fields to return. id is always returned.
sortstring#
Comma-separated fields to sort by: label, created_at or updated_at. Prefix a field with - for descending. Defaults to label. The location id is always the final tiebreak.
filter[q]string#
Locations whose label contains this text, ignoring case.
filter[id]integer#
The location with this integer id. Takes [gt], [gte], [lt], [lte], [in] and [not_in] with a comma-separated list.

Responses

200

One page of results.

Location[]

{
  "data": [
    {
      "id": 1,
      "label": "string",
      "created_at": "2026-06-12T10:00:00+00:00",
      "updated_at": "2026-06-12T10:00:00+00:00"
    }
  ],
  "meta": {
    "limit": 1,
    "next_cursor": "string",
    "prev_cursor": "string"
  }
}

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error

403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error

422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/locations\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"