Gallery Platform API
Reference

Query artworks with a filter document

Runs a filter document over the gallery's artworks and returns one page of matches, with cursor pagination and the list's sort. Rules join by AND: `any_of` matches any value, `none_of` excludes values but keeps works with none set, and an artist rule matches collaborations. Pass `summary: true` for the count and value over every match.

POST
/gallery/artworks/query

Runs a filter document over the gallery's artworks and returns one page of matches, with cursor pagination and the list's sort. Rules join by AND: any_of matches any value, none_of excludes values but keeps works with none set, and an artist rule matches collaborations. Pass summary: true for the count and value over every match.

Authorization

bearerAuth artworks:read, gallery:read, artists:read
AuthorizationBearer <token>

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

In: header

Scope: artworks:read, gallery:read, artists:read

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Run a filter document over the gallery's artworks.

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",      "title": "string",      "artist_id": "string",      "artists": [        {          "artist_id": "string",          "role": "primary",          "position": -9007199254740991,          "artist_name": "string"        }      ],      "dimensions": [        {          "component": "overall",          "label": "string",          "height_cm": 0,          "width_cm": 0,          "depth_cm": 0,          "position": -9007199254740991,          "note": "string"        }      ],      "artist_name": "string",      "thumbnail_url": "string",      "inventory_number": "string",      "ownership_status": "owned",      "availability_state": "available",      "medium": "string",      "year": -9007199254740991,      "end_year": -9007199254740991,      "date_precision": "year",      "date_display": "string",      "description": "string",      "dimension_unit": "in",      "height_cm": 0,      "width_cm": 0,      "depth_cm": 0,      "framed_height_cm": 0,      "framed_width_cm": 0,      "framed_depth_cm": 0,      "dimensions_text": "string",      "location_id": "string",      "price_cents": -9007199254740991,      "currency": "string",      "is_edition": true,      "edition_number": -9007199254740991,      "edition_size": -9007199254740991,      "edition_type": "numbered",      "edition_overrides": [        "string"      ],      "parent_artwork_id": "string",      "coa_status": "not_required",      "coa_tracking_number": "string",      "condition_status": "excellent",      "condition_notes": "string",      "provenance": "string",      "exhibition_history": "string",      "literature": "string",      "catalogue_raisonne": "string",      "market": "primary",      "work_type": "painting",      "custom_status_id": "string",      "show_price_publicly": true,      "published_at": "string",      "published_version": -9007199254740991,      "save_state": "new",      "source_system": "string",      "source_external_id": "string",      "ulan": "string",      "wikidata": "string",      "isni": "string",      "viaf": "string",      "lei": "string",      "formats": [        {          "id": "string",          "artwork_id": "string",          "label": "string",          "height_cm": 0,          "width_cm": 0,          "depth_cm": 0,          "dimension_unit": "in",          "medium": "string",          "edition_size": -9007199254740991,          "stock_quantity": -9007199254740991,          "availability_state": "available",          "price_cents": -9007199254740991,          "currency": "string",          "position": -9007199254740991,          "metadata": {            "property1": "string",            "property2": "string"          },          "created_at": "string",          "updated_at": "string"        }      ],      "metadata": {        "property1": "string",        "property2": "string"      },      "created_at": "string",      "updated_at": "string"    }  ],  "next_cursor": "string",  "summary": {    "total": -9007199254740991,    "by_availability": {      "property1": -9007199254740991,      "property2": -9007199254740991    },    "by_ownership": {      "property1": -9007199254740991,      "property2": -9007199254740991    },    "by_market": {      "property1": -9007199254740991,      "property2": -9007199254740991    },    "value": [      {        "currency": "string",        "count_priced": -9007199254740991,        "sum_cents": -9007199254740991      }    ],    "unpriced": -9007199254740991,    "base_currency": "string",    "converted_total_cents": -9007199254740991  }}