Gallery Platform API
Reference

List consignments

Lists the gallery's consignment terms across all artworks, newest first, with cursor pagination. Filter by `direction` (in/out), `counterparty_contact_id`, or `expiring_before` (an `end_date` on or before a date — the 'lapsing soon' view).

GET
/gallery/consignments

Lists the gallery's consignment terms across all artworks, newest first, with cursor pagination. Filter by direction (in/out), counterparty_contact_id, or expiring_before (an end_date on or before a date — the 'lapsing soon' view).

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
Range1 <= value <= 100
Default20
cursor?string
direction?string

Value in

  • "in"
  • "out"
counterparty_contact_id?string
expiring_before?string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate

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",      "artwork_id": "string",      "direction": "string",      "counterparty_contact_id": "string",      "consignor_share_bps": -9007199254740991,      "consignee_share_bps": -9007199254740991,      "third_party_share_bps": -9007199254740991,      "net_price_cents": -9007199254740991,      "start_date": "string",      "end_date": "string",      "notes": "string",      "created_at": "string",      "updated_at": "string"    }  ],  "next_cursor": "string"}

Delete a consignment DELETE

Permanently deletes a consignment's terms. This is a hard delete — to wind a term down instead, set its end_date via PATCH.

Amend consignment terms PATCH

Amends a consignment's splits, counterparty, dates, or notes. Direction is fixed at creation and cannot change (it drives which side a sale's payable pays).