Public API Documentation > Resources > Partners

Partners API

A partner provides artworks.

Retrieving Partners

Retrieve partners by following the partners link from root.

curl -v "" -H "X-XAPP-Token: XAPP_TOKEN"

This endpoint accepts the following parameters.

Name Value
user_id Retrieve partners that a user has access to.
partner_id Combine with 'user_id' to check whether a user has access to this partner.

The response is a paginated result with embedded partners.

Retrieving a Partner

Users can retrieve a specific partner by ID by rendering the "partner" link template from root.

curl -v "{id}" -H "X-XAPP-Token: XAPP_TOKEN"

Partner JSON Format

error: the server responded with status 404


Key Target
self The partner resource.
profile Partner profile.
permalink An external location on the website.
website Official website.
artworks Partner artworks.
artists Partner artists.
published_artworks All published partner artworks.
shows Partner shows.


  "id": "4f99c7b793ab4b0001000179",
  "slug": "national-gallery-of-art-washington-dc",
  "created_at": "2012-04-26T22:09:59+00:00",
  "updated_at": "2023-09-24T01:31:12+00:00",
  "type": "Institution",
  "name": "National Gallery of Art, Washington, D.C.",
  "email": "",
  "region": "North America",
  "enforce_on_platform_transactions": null,
  "_links": {
    "self": {
      "href": ""
    "profile": {
      "href": ""
    "artworks": {
      "href": ""
    "artists": {
      "href": ""
    "published_artworks": {
      "href": ""
    "partner_contacts": {
      "href": ""
    "shows": {
      "href": ""
    "permalink": {
      "href": ""
    "website": {
      "href": ""