collection

Return a single Collection by ID for the current workspace, or null if no such Collection exists here.

MCP: getCollection

Arguments

id ID! required: ID of the Collection to fetch, as returned by the collections query for this workspace.

Returns

Returns Collection .

Open in explorer ↗

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

Fetch a single Collection by its ID.

query.graphql

query CollectionDefault($id: ID!) {
  collection(id: $id) {
    id
    name
    itemCount
    createdAt
    updatedAt
  }
}

variables.json

{
  "id": "122321ce-843e-5b07-9f56-94323c0ae39e"
}

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 CollectionDefault($id: ID!) {\n  collection(id: $id) {\n    id\n    name\n    itemCount\n    createdAt\n    updatedAt\n  }\n}",
  "variables": {
    "id": "122321ce-843e-5b07-9f56-94323c0ae39e"
  }
}'

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 CollectionDefault($id: ID!) {
  collection(id: $id) {
    id
    name
    itemCount
    createdAt
    updatedAt
  }
}`,
    variables: {
      "id": "122321ce-843e-5b07-9f56-94323c0ae39e"
    }
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  query CollectionDefault($id: ID!) {
    collection(id: $id) {
      id
      name
      itemCount
      createdAt
      updatedAt
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query, variables: { "id" => "122321ce-843e-5b07-9f56-94323c0ae39e" } }.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 CollectionDefault($id: ID!) {
  collection(id: $id) {
    id
    name
    itemCount
    createdAt
    updatedAt
  }
}
"""

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

200 OK

{
  "data": {
    "collection": {
      "id": "122321ce-843e-5b07-9f56-94323c0ae39e",
      "name": "Best Sellers",
      "itemCount": 3,
      "createdAt": "2024-12-31T21:00:00Z",
      "updatedAt": "2024-12-31T21:00:00Z"
    }
  }
}