collectionsConnection Query

Description

Retrieves a paginated list of collections.

query collectionsConnection($page: Int, $perPage: Int, $term: String) {
  collectionsConnection(page: $page, perPage: $perPage, term: $term) {
    collections {
      _id
      created
      id
      title
      handle
      viewType
      path
    }
    pagination {
      limit
      count
      page
      pages
      hasMore
    }
  }
}

Variables

{
    "page": 1,
    "perPage": 42,
    "term": "term"
}

Response

{
    "collectionsConnection": {
        "collections": [
            {
                "_id": "e5469d59d94c5a6846e884b7",
                "created": 1738838903394,
                "id": 562711862274,
                "title": "example",
                "handle": "example",
                "viewType": "example",
                "path": "/release/1763553751/release-artist-release-name"
            }
        ],
        "pagination": {
            "limit": 20,
            "count": 10,
            "page": 1,
            "pages": 1,
            "hasMore": true
        }
    }
}

Arguments

Name	Type	Description
page	Int	Use this argument to specify the page number.
perPage	Int	Number of collections per page. You can request a specific page size, and it will be used if it does not exceed the server-enforced maximum. If your requested size exceeds the maximum, the server will enforce the maximum limit.
term	String	Search term to filter collections by

Returns

CollectionsConnection!