Query

campaigns

List and paginate campaigns for the current workspace, ordered newest first. Workflow-type rows are excluded to match the in-app CRM listing.

Paginated · weighted cost MCP: getCampaigns

Arguments

after String default null: Cursor for fetching the next page of results.
first Int default 20: Number of campaigns to return (page size).

Returns

A paginated connection of Campaign nodes. See Pagination for the connection shape.

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.

edges [CampaignEdge!]!: List of edges with cursors.
cursor String!: Cursor for this node.
node Campaign!: The campaign.
createdAt DateTime!: When the campaign was created (UTC).
id ID!: Unique identifier for the campaign in Archive's system.
name String!: Campaign name as shown in Archive.
nodes [Campaign!]!: List of campaigns.
createdAt DateTime!: When the campaign was created (UTC).
id ID!: Unique identifier for the campaign in Archive's system.
name String!: Campaign name as shown in Archive.
pageInfo PageInfo!: Pagination information.
endCursor String: Cursor for the last node in this page.
hasNextPage Boolean!: Whether there are more results after this page.
hasPreviousPage Boolean!: Whether there are results before this page.
startCursor String: Cursor for the first node in this page.
totalCount Int: Total number of items available.

Open in explorer ↗

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

Paginate the workspace's campaigns, newest first.

query.graphql

query CampaignsDefault($first: Int, $after: String) {
  campaigns(first: $first, after: $after) {
    totalCount
    edges {
      node {
        id
        name
        createdAt
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

variables.json

{
  "first": 10
}

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 CampaignsDefault($first: Int, $after: String) {\n  campaigns(first: $first, after: $after) {\n    totalCount\n    edges {\n      node {\n        id\n        name\n        createdAt\n      }\n    }\n    pageInfo {\n      hasNextPage\n      endCursor\n    }\n  }\n}",
  "variables": {
    "first": 10
  }
}'

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 CampaignsDefault($first: Int, $after: String) {
  campaigns(first: $first, after: $after) {
    totalCount
    edges {
      node {
        id
        name
        createdAt
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}`,
    variables: {
      "first": 10
    }
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  query CampaignsDefault($first: Int, $after: String) {
    campaigns(first: $first, after: $after) {
      totalCount
      edges {
        node {
          id
          name
          createdAt
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query, variables: { "first" => 10 } }.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 CampaignsDefault($first: Int, $after: String) {
  campaigns(first: $first, after: $after) {
    totalCount
    edges {
      node {
        id
        name
        createdAt
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}
"""

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

200 OK 34 lines

{
  "data": {
    "campaigns": {
      "totalCount": 3,
      "edges": [
        {
          "node": {
            "id": "115d4e8e-2e30-5d2b-acb8-78cf3d81eab1",
            "name": "Fall Refresh",
            "createdAt": "2024-12-31T00:00:00Z"
          }
        },
        {
          "node": {
            "id": "5ff72fbc-0217-540f-bf25-a83d049772b8",
            "name": "Summer Gifting",
            "createdAt": "2024-12-30T00:00:00Z"
          }
        },
        {
          "node": {
            "id": "422fac58-557c-5cd4-8986-84ac3db4b133",
            "name": "Spring Launch",
            "createdAt": "2024-12-29T00:00:00Z"
          }
        }
      ],
      "pageInfo": {
        "hasNextPage": false,
        "endCursor": "Z2lkOi8vYXJjaGl2ZS9DYW1wYWlnbi8yMDI0LTEyLTI5VDAwOjAwOjAwLjAwMDAwMFp8NDIyZmFjNTgtNTU3Yy01Y2Q0LTg5ODYtODRhYzNkYjRiMTMz"
      }
    }
  }
}