Gallery Platform API
Reference

List parties

Lists the gallery's parties, newest first, with cursor pagination. Parties hidden from the Contacts list (artist-only, member and gallery parties) are left out unless `listed=all`. Archived parties are left out unless `archived=true`. Pass `ids` (comma-separated, max 50) to fetch an explicit set.

GET
/gallery/parties

Lists the gallery's parties, newest first, with cursor pagination. Parties hidden from the Contacts list (artist-only, member and gallery parties) are left out unless listed=all. Archived parties are left out unless archived=true. Pass ids (comma-separated, max 50) to fetch an explicit set.

Authorization

bearerAuth contacts:read
AuthorizationBearer <token>

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

In: header

Scope: contacts: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
kind?array<>

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

Items1 <= items
contact_type?array<>

Filter to the given contact types (comma-separated).

Items1 <= items
role?string

Parties holding an open role in this comma-separated set (collector, consignor, lender, …).

lead_status?array<>

Filter to the given lead status.

Items1 <= items
tag_id?array<string>

Filter to the given tag id.

Items1 <= items <= 10
archived?string

true: only archived parties; absent or false: live parties only.

listed?string

all includes the parties hidden from the Contacts list (artist-only, member and gallery parties).

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": "person",      "contact_type": "collector",      "company": "string",      "city": "string",      "email": "string",      "phone": "string",      "notes": "string",      "lead_status": "new",      "form_of_address": "string",      "locale": "string",      "do_not_email": true,      "do_not_sms": true,      "acquisition_source": "inquiry",      "acquired_at": "string",      "archived_at": "string",      "ulan": "string",      "wikidata": "string",      "isni": "string",      "viaf": "string",      "lei": "string",      "assignee_ids": [        "string"      ],      "collector_profile": {        "collecting_focus": "string",        "budget_band": "string",        "wishlist_notes": "string",        "preferred_contact_method": "string",        "vip": true,        "tax_exempt": true,        "created_at": "string",        "updated_at": "string"      },      "institution_profile": {        "institution_kind": "string",        "tax_exempt": true,        "acquisition_process": "string",        "primary_contact_name": "string",        "created_at": "string",        "updated_at": "string"      },      "last_interaction_at": "string",      "last_interaction_type": "note",      "roles": [        {          "role": "collector",          "valid_from": "string"        }      ],      "custom_fields": {        "property1": null,        "property2": null      },      "save_state": "new",      "metadata": {        "property1": "string",        "property2": "string"      },      "created_at": "string",      "updated_at": "string"    }  ],  "next_cursor": "string"}