QUERY

customAttributeSchemas

Retrieve custom attribute schemas to interpret customAttributes values. Returns at most 1000 rows; this field is not paginated.

MCP: getCustomAttributeSchemas

Arguments

entity CustomAttributeSchemaEntity! required: Entity type to get schemas for (ITEM or CREATOR).

Returns

Returns [CustomAttributeSchema!]! .

Open in explorer ↗

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

Retrieve the schemas needed to interpret item or creator custom attributes.

query.graphql

query CustomAttributeSchemasDefault($entity: CustomAttributeSchemaEntity!) {
  customAttributeSchemas(entity: $entity) {
    key
    name
    type
  }
}

variables.json

{
  "entity": "ITEM"
}

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 CustomAttributeSchemasDefault($entity: CustomAttributeSchemaEntity!) {\n  customAttributeSchemas(entity: $entity) {\n    key\n    name\n    type\n  }\n}",
  "variables": {
    "entity": "ITEM"
  }
}'

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 CustomAttributeSchemasDefault($entity: CustomAttributeSchemaEntity!) {
  customAttributeSchemas(entity: $entity) {
    key
    name
    type
  }
}`,
    variables: {
      "entity": "ITEM"
    }
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  query CustomAttributeSchemasDefault($entity: CustomAttributeSchemaEntity!) {
    customAttributeSchemas(entity: $entity) {
      key
      name
      type
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query, variables: { "entity" => "ITEM" } }.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 CustomAttributeSchemasDefault($entity: CustomAttributeSchemaEntity!) {
  customAttributeSchemas(entity: $entity) {
    key
    name
    type
  }
}
"""

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

200 OK

{
  "data": {
    "customAttributeSchemas": [
      {
        "key": "links",
        "name": "Links",
        "type": "TEXT_LIST"
      },
      {
        "key": "post_summary",
        "name": "Post Summary",
        "type": "TEXT"
      },
      {
        "key": "sentiment",
        "name": "Sentiment",
        "type": "SINGLE_SELECT_V2"
      },
      {
        "key": "collections",
        "name": "Collections",
        "type": "MULTIPLE_SELECT_V2"
      }
    ]
  }
}