v1

latestOpenAPI 3.0.02026-07-131091452.6 MB

catalog

List catalog collections

This endpoint returns a list of catalog collections.

get/v2/catalog/collections

Query parameters

pageinteger

Page number

per_pageinteger

Number of results per page

sort'newest' | 'oldest'

Sort by

sharedboolean

Set to true to omit collections that you own and return only collections that are shared with you

Response

pagenumber required

per_pagenumber required

total_countnumber required

Example response

{
  "page": 1,
  "per_page": 20,
  "total_count": 1,
  "data": [
    {
      "id": "126351028",
      "name": "My collection",
      "cover_asset": {
        "id": "123",
        "asset": {
          "id": "1690105108",
          "type": "image",
          "name": "Young couple playing tennis at the court"
        },
        "created_time": "2021-06-10T13:26:09-04:00"
      },
      "total_item_count": 2,
      "created_time": "2021-05-20T16:15:22-04:00",
      "updated_time": "2021-06-10T13:26:09-04:00",
      "visibility": "public",
      "role_assignments": {
        "collection_id": "126351028",
        "roles": {
          "owners": [
            {
              "id": "321",
              "type": "USER",
              "email": "userOne@org.com"
            }
          ],
          "editors": [
            {
              "id": "987",
              "type": "USER",
              "email": "userTwo@org.com"
            }
          ],
          "viewers": []
        }
      }
    }
  ]
}