Userset Details

The sets of objects users created in Rijksstudio are available in the REST API. The Usersets endpoint provides an overview of available sets. The Userset Details endpoint returns details about a specific set, including the list of objects.

Userset Details Base URL

https://www.rijksmuseum.nl/api/{culture}/usersets/{set-id}

The id of a set is composed of a user id, dash and name of set. You can retrieve id's from the Usersets endpoint.

Parameter	Format	Default	Notes
key	a-z	0-9
format	json / jsonp / xml	json	The format of the result.
culture	nl / en		The language of the set.
set-id	0-9		The ID of the set.
page	0-n	0	The result page to fetch.
pageSize	1-100	25	The number of results per page.

note

Note that page * pageSize cannot exceed 10,000.

Example Userset Details API

Request

https://www.rijksmuseum.nl/api/nl/usersets/1836065-meestermatches?key={api-key}&format=json

Response

{
  "elapsedMilliseconds": 505,
  "userSet": {
    "links": {
      "overview": "https://www.rijksmuseum.nl/api/usersets",
      "web": "https://www.rijksmuseum.nl/nl/mijn/verzamelingen/321--john/setname-3"
    },
    "id": "123-setname-3",
    "count": 25,
    "type": "Default",
    "name": "setname (3)",
    "slug": "setname-3",
    "description": null,
    "user": {
      "id": 321,
      "name": "John",
      "lang": "nl",
      "avatarUrl": null,
      "headerUrl": null,
      "initials": "B"
    },
    "setItems": [
      {
        "links": {
          "artobject": "https://www.rijksmuseum.nl/api/nl/collection/SK-A-3148",
          "web": "https://www.rijksmuseum.nl/nl/collection/SK-A-3148"
        },
        "id": "8c6e3ec4-08d9-4547-b72a-36907c0a3823",
        "objectNumber": "SK-A-3148",
        "relation": "None",
        "relationDescription": "Held",
        "cropped": false,
        "cropX": 0,
        "cropY": 0,
        "cropWidth": 0,
        "cropHeight": 0,
        "origWidth": 0,
        "origHeight": 0,
        "image": {
          "guid": "6d40dc7d-e58c-4e13-812d-60cff190a3d5",
          "parentObjectNumber": "SK-A-3148",
          "cdnUrl": "http://lh4.ggpht.com/X6E9IJ33ioVI1W7x0XgDedCmAu5NizMlLuX2f6gSgmpFqMxCCU1qOSCOqc2ORrLw-nHLtaph1zStxZFKKWqlnRU1IUw=s0",
          "cropX": 0,
          "cropY": 0,
          "width": 1824,
          "height": 2500,
          "offsetPercentageX": 50,
          "offsetPercentageY": 36
        }
      },
      // more results...
    ],
    "createdOn": "2017-02-12T19:13:17.01Z",
    "updatedOn": "2017-02-12T19:13:17.01Z"
  }
}