Gallery Platform API
Reference

List artwork lists

Lists the gallery's artwork lists (viewing rooms, fair/price lists, exhibitions), newest first, with cursor pagination.

GET
/gallery/lists

Lists the gallery's artwork lists (viewing rooms, fair/price lists, exhibitions), newest first, with cursor pagination.

Authorization

bearerAuth artworks:read
AuthorizationBearer <token>

A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).

In: header

Scope: artworks: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.

kind?string

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

Value in

  • "viewing_room"
  • "fair"
  • "price_list"
  • "exhibition"
  • "selection"
q?string

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

Length1 <= length <= 200
tag_id?array<string>

Filter to the given tag id.

Items1 <= items <= 10

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",      "slug": "string",      "title": "string",      "description": "string",      "kind": "viewing_room",      "visibility": "public",      "is_dynamic": true,      "dynamic_query": {        "property1": null,        "property2": null      },      "show_prices": true,      "show_status": true,      "show_location": true,      "allow_purchase": true,      "cover_image_path": "string",      "cover_url": "string",      "theme_overrides": {        "accent_color": "string",        "background_color": "string",        "text_color": "string",        "font_family": "sans",        "layout": "grid"      },      "brand_logo_storage_path": "string",      "brand_logo_url": "string",      "metadata": {        "property1": "string",        "property2": "string"      },      "access": {        "audience_kind": "public",        "audience_contact_id": "string",        "audience_contact_list_id": "string",        "audience_label": "string",        "require_email": true,        "email_gate_mode": "collect",        "has_passcode": true      },      "created_at": "string",      "updated_at": "string"    }  ],  "next_cursor": "string"}