Jump to examples ↓

Query

workspace

Return details for the current workspace, inferred from the WORKSPACE-ID header.

MCP: getWorkspace

Arguments

This field takes no arguments.

Returns

Returns Workspace! .

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.

hashtags [Tag!]: Hashtags tracked for this workspace.
id ID!: Unique identifier for the tag in Archive's system.
name String!: The text of the tag.
provider Provider!: Platform where this tag was observed (for example INSTAGRAM, TIKTOK, YOUTUBE, or INTERNAL).
INSTAGRAM: Instagram platform integration, including posts, reels, stories, and profile data.
INTERNAL: Internal Archive-managed source used for synthetic or system-generated content.
TIKTOK: TikTok platform integration, including videos and creator profile data.
YOUTUBE: YouTube platform integration, including Shorts, videos, thumbnails, and profile data.
type TagType!: Whether this tag is a HASHTAG or a MENTION.
HASHTAG: Hashtag tag (e.g. #archive)
MENTION: User mention tag (e.g. @archive)
id ID!: Unique identifier for the workspace (UUID format).
integrations [Integration!]!: Connected social accounts for this workspace. Distinct from mentions, which lists tracked terms (the @-handles Archive monitors); this field lists connected accounts, one entry per integration. Multiple integrations may share the same handle, and each entry carries its own status. Includes disconnected and failed integrations so you can detect broken connections.
connectedAt DateTimeWithZone!: Timestamp when the integration was first established (ISO 8601 UTC).
handle String!: Public-facing account handle for this integration (for example "support_testing"). Sourced from the associated mention tag.
id ID!: Stable unique identifier for this integration (UUID). Distinguishes multiple integrations that share the same handle.
provider Provider!: Platform on which this account is connected (for example INSTAGRAM, TIKTOK, YOUTUBE, or INTERNAL).
INSTAGRAM: Instagram platform integration, including posts, reels, stories, and profile data.
INTERNAL: Internal Archive-managed source used for synthetic or system-generated content.
TIKTOK: TikTok platform integration, including videos and creator profile data.
YOUTUBE: YouTube platform integration, including Shorts, videos, thumbnails, and profile data.
status IntegrationStatus!: Lifecycle state of the integration. CONNECTED = active and verified; DISCONNECTED = the account was removed or the integration failed; PENDING = setup in progress.
CONNECTED: The integration is active and verified; Archive can fetch content for this account.
DISCONNECTED: The integration has been removed by the user or has failed and is no longer active. Archive cannot fetch new content for this account until it is reconnected.
PENDING: The integration is being established; initial verification or onboarding has not completed yet.
keywords [Keyword!]: Keywords tracked for this workspace (primarily YouTube). Distinct from hashtags and mentions, which surface Instagram/TikTok-style tags.
id ID!: Unique identifier for the keyword in Archive's system.
name String!: The exact phrase being tracked (for example "noodles worth loving"). Named name for consistency with Tag.name; backed by the keywords.value column.
provider Provider!: Platform on which this keyword is tracked (currently YOUTUBE; reserved for future providers).
INSTAGRAM: Instagram platform integration, including posts, reels, stories, and profile data.
INTERNAL: Internal Archive-managed source used for synthetic or system-generated content.
TIKTOK: TikTok platform integration, including videos and creator profile data.
YOUTUBE: YouTube platform integration, including Shorts, videos, thumbnails, and profile data.
mentions [Tag!]: User mentions tracked for this workspace.
id ID!: Unique identifier for the tag in Archive's system.
name String!: The text of the tag.
provider Provider!: Platform where this tag was observed (for example INSTAGRAM, TIKTOK, YOUTUBE, or INTERNAL).
INSTAGRAM: Instagram platform integration, including posts, reels, stories, and profile data.
INTERNAL: Internal Archive-managed source used for synthetic or system-generated content.
TIKTOK: TikTok platform integration, including videos and creator profile data.
YOUTUBE: YouTube platform integration, including Shorts, videos, thumbnails, and profile data.
type TagType!: Whether this tag is a HASHTAG or a MENTION.
HASHTAG: Hashtag tag (e.g. #archive)
MENTION: User mention tag (e.g. @archive)
name String!: Human-readable name of the workspace.

Open in explorer ↗

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

Return details for the workspace inferred from the WORKSPACE-ID header.

query.graphql

query WorkspaceDefault {
  workspace {
    id
    name
  }
}

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 WorkspaceDefault {\n  workspace {\n    id\n    name\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 WorkspaceDefault {
  workspace {
    id
    name
  }
}`
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  query WorkspaceDefault {
    workspace {
      id
      name
    }
  }
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 WorkspaceDefault {
  workspace {
    id
    name
  }
}
"""

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 8 lines

{
  "data": {
    "workspace": {
      "id": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a",
      "name": "Northwind Botanicals"
    }
  }
}

Error responses

400 Error — missing WORKSPACE-ID header

Requests without a WORKSPACE-ID header are rejected with HTTP 400.

Open in explorer ↗

query.graphql

query WorkspaceDefault {
  workspace {
    id
    name
  }
}

Headers

Content-Type: application/json
Authorization: Bearer docs_demo_token_0000000000000000000000

Request · cURL

curl https://app.archive.com/api/v2 \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer docs_demo_token_0000000000000000000000' \
  -d '{
  "query": "query WorkspaceDefault {\n  workspace {\n    id\n    name\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"
  },
  body: JSON.stringify({
    query: `query WorkspaceDefault {
  workspace {
    id
    name
  }
}`
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  query WorkspaceDefault {
    workspace {
      id
      name
    }
  }
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"
)
puts response.body

Request · Python

import json
import requests

query = """
query WorkspaceDefault {
  workspace {
    id
    name
  }
}
"""

response = requests.post(
    "https://app.archive.com/api/v2",
    json={"query": query},
    headers={
        "Content-Type": "application/json",
        "Authorization": "Bearer docs_demo_token_0000000000000000000000",
    },
)
print(json.dumps(response.json(), indent=2))

400 Bad Request 3 lines

{
  "errors": "WORKSPACE-ID header is required"
}

404 Error — unknown workspace

An unknown WORKSPACE-ID is rejected with HTTP 404.

Open in explorer ↗

query.graphql

query WorkspaceDefault {
  workspace {
    id
    name
  }
}

Headers

Content-Type: application/json
Authorization: Bearer docs_demo_token_0000000000000000000000
WORKSPACE-ID: 00000000-0000-0000-0000-000000000000

Request · cURL

curl https://app.archive.com/api/v2 \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer docs_demo_token_0000000000000000000000' \
  -H 'WORKSPACE-ID: 00000000-0000-0000-0000-000000000000' \
  -d '{
  "query": "query WorkspaceDefault {\n  workspace {\n    id\n    name\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": "00000000-0000-0000-0000-000000000000"
  },
  body: JSON.stringify({
    query: `query WorkspaceDefault {
  workspace {
    id
    name
  }
}`
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  query WorkspaceDefault {
    workspace {
      id
      name
    }
  }
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" => "00000000-0000-0000-0000-000000000000"
)
puts response.body

Request · Python

import json
import requests

query = """
query WorkspaceDefault {
  workspace {
    id
    name
  }
}
"""

response = requests.post(
    "https://app.archive.com/api/v2",
    json={"query": query},
    headers={
        "Content-Type": "application/json",
        "Authorization": "Bearer docs_demo_token_0000000000000000000000",
        "WORKSPACE-ID": "00000000-0000-0000-0000-000000000000",
    },
)
print(json.dumps(response.json(), indent=2))

404 Not Found 3 lines

{
  "errors": "Shop not found"
}