collectionPageByHandle

Returns a collection page by handle in a draft or published state.

Arguments

Name
handle
Type
String!
Description
The handle of the collection page.
Name
version
Type
Version
Description
The state of the collection page you want to retrieve.
- To get the latest content use CURRENT.
- To get the latest published content use PUBLISHED
Name
draftId
Type
ID
Description
Legacy, from the drafts system that Content Releases replaced. To read or write a release's changes, send the X-Pack-Release-Id header instead. See Content Releases.

To get localized content, pass language and country to the @inContext directive on the query instead. See Localization.

Returns

Name
CollectionPage.*
Type
CollectionPage
Description
Any requested field from the Collectionpage object.

Request

import { PackClient } from '@pack/client'
const packClient = new PackClient({
  token: 'YOUR-PACK-TOKEN'
});

const query = `
query GetCollectionPageByHandle($handle: String!, $version: Version) {
      collectionPageByHandle(handle: $handle, version: $version) {
        title
        handle
        description
      }
    }
`
const variables = {
  handle: 'collection-page-handle',
}
const response = await packClient.fetch(query, { variables: variables });
console.log(response.data);

Response

{
    "data": {
        "collectionPageByHandle": {
            "title": "Collection Page Title",
            "handle": "collection-page-title",
            "description": "Collection Page Description"
        }
    }
}