Gallery Platform API
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`.

GET
/gallery/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.

Authorization

bearerAuth locations:read
AuthorizationBearer <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

Page size. Defaults to 20; the maximum is 100.

Range1 <= value <= 100
Default20
cursor?string

Opaque cursor from the previous page's next_cursor. Omit for the first page.

q?string

Free-text search over the resource's searchable fields.

Lengthlength <= 200
kind?array<>

Filter to the given kind; the schema's enum lists the values.

Items1 <= items <= 13
parent_id?string

Filter to the given parent id.

is_active?string

Filter by active state.

tag_id?array<string>

Filter to the given tag id.

Items1 <= items <= 10
sort?string

Sort by one of: name, created, updated (default created).

Value in

  • "name"
  • "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,      "metadata": {        "property1": "string",        "property2": "string"      },      "created_at": "string",      "updated_at": "string"    }  ],  "next_cursor": "string"}