Reference
List locations
Lists the gallery's managed locations with cursor pagination. Filter by `q` (name/address/notes substring), `kind`, `parent_id` (direct children of a location), or `is_active`.
Lists the gallery's managed locations with cursor pagination. Filter by q (name/address/notes substring), kind, parent_id (direct children of a location), or is_active.
Authorization
bearerAuth locations:readAuthorizationBearer <token>
A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: locations:read
Query Parameters
limit?integer
Range
1 <= value <= 100Default
20cursor?string
q?string
Length
length <= 200kind?string
Value in
- "gallery"
- "warehouse"
- "storage"
- "viewing_room"
- "office"
- "art_fair"
- "on_loan"
- "consignment"
- "client_home"
- "framer"
- "conservator"
- "in_transit"
- "other"
parent_id?string
is_active?string
tag_id?array<string>
Items
1 <= items <= 10sort?string
Sort by one of: created, updated (default created).
Value in
- "created"
- "updated"
dir?string
Sort direction (default desc).
Value in
- "asc"
- "desc"
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "data": [ { "id": "string", "name": "string", "kind": "gallery", "parent_id": "string", "contact_id": "string", "address": "string", "notes": "string", "is_active": true, "created_at": "string", "updated_at": "string" } ], "next_cursor": "string"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}