Gallery Platform API
Reference

List artworks

Lists the gallery's artworks, newest first, with cursor pagination. Pass `draft=true` to get the editor's working copy (pending edits overlaid) instead of the published state. Pass `ids` (comma-separated, max 50) to fetch an explicit set.

GET
/gallery/artworks

Lists the gallery's artworks, newest first, with cursor pagination. Pass draft=true to get the editor's working copy (pending edits overlaid) instead of the published state. Pass ids (comma-separated, max 50) to fetch an explicit set.

Authorization

bearerAuth artworks: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, artists: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.

ids?array<string>

Comma-separated ids to fetch as an explicit set (maximum 50).

Items1 <= items <= 50
q?string

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

Lengthlength <= 200
availability?array<>

Filter to the given availability states (repeatable).

Items1 <= items
ownership?array<>

Filter to the given ownership kinds (repeatable).

Items1 <= items
condition?array<>

Filter to the given condition values (repeatable).

Items1 <= items
market?array<>

Filter to the given markets (repeatable).

Items1 <= items
artist_id?string

Filter to the given artist id.

medium?string

Filter to the given media (repeatable).

Lengthlength <= 200
price_min?integer

Lower bound on price, inclusive.

Range0 <= value <= 9007199254740991
price_max?integer

Upper bound on price, inclusive.

Range0 <= value <= 9007199254740991
year_min?integer

Lower bound on year, inclusive.

Range-9007199254740991 <= value <= 9007199254740991
year_max?integer

Upper bound on year, inclusive.

Range-9007199254740991 <= value <= 9007199254740991
height_min?number

Lower bound on height, inclusive.

Range0 <= value
height_max?number

Upper bound on height, inclusive.

Range0 <= value
width_min?number

Lower bound on width, inclusive.

Range0 <= value
width_max?number

Upper bound on width, inclusive.

Range0 <= value
unpriced?string

When true, only rows with no price.

published?|

Filter by published state.

has_image?string

When true, only rows with at least one image.

tag_id?array<string>

Filter to the given tag id.

Items1 <= items <= 10
sort?string

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

Value in

  • "created"
  • "updated"
  • "price"
  • "year"
dir?string

Sort direction (default desc).

Value in

  • "asc"
  • "desc"
draft?string

When true, return the editor's working copy (pending edits overlaid) instead of the published state.

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",      "custom_status_id": "string",      "show_price_publicly": true,      "published_at": "string",      "published_version": -9007199254740991,      "save_state": "new",      "source_system": "string",      "source_external_id": "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"}

List artwork interests GET

Lists the contacts who have registered interest in an artwork (the "who's interested" view), newest first.

List artwork location history GET

Lists an artwork's location / movement history, newest first. Appended automatically whenever the artwork's location changes.