Jump to examples ↓

Query

collections

List Collections (saved tag sets) for the current workspace, in the workspace's saved order. Returns at most 1000 rows; this field is not paginated.

MCP: getCollections

Arguments

This field takes no arguments.

Returns

Returns [Collection!]! .

Object, input and enum types open in place — use + to reveal their fields. A type that is already open above the row stops at a ↻ circular marker, and anything nested past the depth limit links out to its own page instead.

createdAt DateTimeWithZone!: When the Collection was created.
group ViewGroup: Group this Collection belongs to, or null when ungrouped. Populated by moveCollectionToGroup. Always null for workspaces whose Collections use the older storage.
collections [Collection!]!: Collections that belong to this group, ordered by their position within the group.
createdAt DateTimeWithZone!: When the Collection was created.
group ViewGroup ↻ circular view ViewGroup →: Group this Collection belongs to, or null when ungrouped. Populated by moveCollectionToGroup. Always null for workspaces whose Collections use the older storage.
id ID!: Unique identifier of the Collection in this workspace. Pass it to addItemToCollections / removeItemFromCollections and to collection(id:).
itemCount Int!: Number of items in this workspace tagged with the Collection.
name String!: Display name of the Collection.
updatedAt DateTimeWithZone!: When the Collection was last updated.
contentViews [ContentView!]!: Content Views that belong to this group, ordered by their position within the group.
createdAt DateTimeWithZone!: When the view was created.
customAttributeConditions JSON!: Custom-attribute conditions narrowing the filter set.
filters JSON!: Opaque filter blob defining which items belong to the view.
group ViewGroup ↻ circular view ViewGroup →: Group this view belongs to, or null when the view is ungrouped. Populated by moveContentViewToGroup.
id ID!: Unique identifier (FilterPreset UUID). Use this with items(presetId:).
name String!: Display name of the view.
showReportingStats Boolean!: Whether reporting stats are surfaced in the UI for this view.
sort JSON!: Sort directives applied when listing items via this view.
updatedAt DateTimeWithZone!: When the view was last updated.
createdAt DateTimeWithZone!: When the group was created.
creatorViews [CreatorView!]!: Creator Views that belong to this group, ordered by their position within the group.
createdAt DateTimeWithZone!: When the view was created.
customAttributeConditions JSON!: Custom-attribute conditions narrowing the filter set.
filters JSON!: Opaque filter blob, stored and echoed back but not applied when reading the view: creators(presetId:) narrows only by this view's customAttributeConditions and sort. Use customAttributeConditions to filter which creators the view returns.
group ViewGroup ↻ circular view ViewGroup →: Group this view belongs to, or null when the view is ungrouped. Populated by moveCreatorViewToGroup.
id ID!: Unique identifier of this saved view. Use the returned id with creators(presetId:) to fetch the view's creators.
name String!: Display name of the view.
showReportingStats Boolean!: Whether reporting stats are surfaced in the UI for this view.
sort JSON!: Sort directives applied when listing creators via this view.
updatedAt DateTimeWithZone!: When the view was last updated.
id ID!: Unique identifier.
name String!: Display name of the group.
socialProfileViews [SocialProfileView!]!: Social Profile Views that belong to this group, ordered by their position within the group.
createdAt DateTimeWithZone!: When the view was created.
customAttributeConditions JSON!: Custom-attribute conditions narrowing the filter set.
filters JSON!: Opaque filter blob, stored and echoed back but not applied when reading the view: socialProfiles(presetId:) narrows only by this view's customAttributeConditions and sort. Use customAttributeConditions to filter which social profiles the view returns.
group ViewGroup ↻ circular view ViewGroup →: Group this view belongs to, or null when the view is ungrouped. Populated by moveSocialProfileViewToGroup.
id ID!: Unique identifier of this saved view. Use the returned id with socialProfiles(presetId:) to fetch the view's social profiles.
name String!: Display name of the view.
showReportingStats Boolean!: Whether reporting stats are surfaced in the UI for this view.
sort JSON!: Sort directives applied when listing social profiles via this view.
updatedAt DateTimeWithZone!: When the view was last updated.
updatedAt DateTimeWithZone!: When the group was last updated.
id ID!: Unique identifier of the Collection in this workspace. Pass it to addItemToCollections / removeItemFromCollections and to collection(id:).
itemCount Int!: Number of items in this workspace tagged with the Collection.
name String!: Display name of the Collection.
updatedAt DateTimeWithZone!: When the Collection was last updated.

Open in explorer ↗

Values are sampled from a demo workspace — substitute your own token and workspace id.

Return every saved Collection (tag set) in the workspace.

query.graphql

query CollectionsDefault {
  collections {
    id
    name
    itemCount
    createdAt
    updatedAt
  }
}

Headers

Authorization: Bearer docs_demo_token_0000000000000000000000
WORKSPACE-ID: 6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a

Request · cURL

curl https://app.archive.com/api/v2 \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer docs_demo_token_0000000000000000000000' \
  -H 'WORKSPACE-ID: 6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a' \
  -d '{
  "query": "query CollectionsDefault {\n  collections {\n    id\n    name\n    itemCount\n    createdAt\n    updatedAt\n  }\n}"
}'

Request · Node.js

const response = await fetch("https://app.archive.com/api/v2", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer docs_demo_token_0000000000000000000000",
    "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a"
  },
  body: JSON.stringify({
    query: `query CollectionsDefault {
  collections {
    id
    name
    itemCount
    createdAt
    updatedAt
  }
}`
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  query CollectionsDefault {
    collections {
      id
      name
      itemCount
      createdAt
      updatedAt
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query }.to_json,
  "Content-Type" => "application/json",
  "Authorization" => "Bearer docs_demo_token_0000000000000000000000",
  "WORKSPACE-ID" => "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a"
)
puts response.body

Request · Python

import json
import requests

query = """
query CollectionsDefault {
  collections {
    id
    name
    itemCount
    createdAt
    updatedAt
  }
}
"""

response = requests.post(
    "https://app.archive.com/api/v2",
    json={"query": query},
    headers={
        "Authorization": "Bearer docs_demo_token_0000000000000000000000",
        "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a",
    },
)
print(json.dumps(response.json(), indent=2))

200 OK 20 lines

{
  "data": {
    "collections": [
      {
        "id": "122321ce-843e-5b07-9f56-94323c0ae39e",
        "name": "Best Sellers",
        "itemCount": 3,
        "createdAt": "2024-12-31T21:00:00Z",
        "updatedAt": "2024-12-31T21:00:00Z"
      },
      {
        "id": "e51b749b-1344-535f-a4c5-f878b69d143b",
        "name": "Seasonal Picks",
        "itemCount": 0,
        "createdAt": "2024-12-31T22:00:00Z",
        "updatedAt": "2024-12-31T22:00:00Z"
      }
    ]
  }
}