Archive API docs
esc
    Jump to
    Getting started Token, first query, response Explorer Run queries in the browser items The connection most integrations start with Changelog Additions and deprecations

    Narrow by kind with a prefix — q: queries, m: mutations, t: types, g: guides, f: fields and arguments.

    Pagination

    Paginated fields return a Relay-style connection. Every connection in the Archive API follows the same shape, so it is documented once here instead of on each field.

    Requesting pages

    Pass first to set the page size and after with a cursor to fetch the next page. Read pageInfo.hasNextPage to know when to stop and pageInfo.endCursor as the next after value.

    Connection fields

    Select nodes for the records directly, or edges when you need the per-node cursor. The types below are shown for one representative connection; every connection substitutes its own node and edge types.

    edges [CampaignEdge!]!
    List of edges with cursors.
    nodes [Campaign!]!
    List of campaigns.
    pageInfo PageInfo!
    Pagination information.
    totalCount Int
    Total number of items available.

    PageInfo

    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.

    For a step-by-step walkthrough of the cursor loop, page bounds, and cost, see the Pagination guide.