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.

    Guides

    Task-oriented guides for the Archive GraphQL API. Start with Getting started, then pick the guide that matches what you're building. For field-level detail, see the API reference.

    01 Getting started 2 min Make your first Archive API call. Authenticate, select a workspace, and fetch a page of content. 02 Core concepts 8 min The Archive data model — workspaces, items, creators and social profiles, Collections and views, custom attributes — and the terms the app and the API spell differently. 03 Authentication 2 min Authenticate Archive API requests with a bearer token, and create, rotate, and store tokens securely. 04 Workspaces 1 min Select a workspace with the WORKSPACE-ID header, learn which operations are workspace-scoped, and handle missing or unknown workspaces. 05 Pagination 2 min Page through Archive connections with first/after cursors and pageInfo, stay within the page-size bounds, and keep pagination cheap. 06 Filtering & search 3 min Narrow the items query with date and engagement ranges, semantic super-search, custom-attribute conditions, sorting, and saved views. 07 Rate limits & plans 4 min Compare the plan ladder, price your own query with the calculator, read the RateLimit headers, and back off correctly. 08 Errors 5 min Distinguish transport errors from GraphQL errors, read the userErrors pattern on mutations, and map each HTTP status to its cause. 09 Webhooks 12 min Subscribe an HTTPS endpoint to new content landing in your views, verify signed deliveries, and recover from failures without losing events. 10 Alpha features 2 min How the X-Archive-Alpha-Features opt-in header works, how alpha surfaces are hidden by default, and the no-stability-contract policy. 11 Changelog 12 min The /api/v2 stability contract, and a reverse-chronological record of changes to the Archive API surface and these guides.