GraphQL API

This doc provides an overview of our GraphQL API which is designed specifically with data integration in mind.

The API is available at /api/graphql/ URL path of your instance.

API returns data in JSON format.

API schema contains Queries and Mutations.

Rate limit is: 250 req / min for media, and 500 req / min for everything else. Max 2 concurrent connections.

GraphQL: concise definitions

Term
Description

Mutation

A write operation that modifies server-side data (create, update, delete) and whose top-level fields execute serially to avoid race conditions.

Query

A read-only operation that fetches data without changing server state; results can be cached and fields are typically resolved in parallel.

Batch

Sending multiple GraphQL operations in a single HTTP request to reduce network overhead; the server executes each operation independently and returns a combined set of results.

Synchronous execution

Executing an operation such that the client waits for the server to complete and return a result in the same request/response cycle; in GraphQL, queries resolve concurrently per field, whereas mutation top-level fields are executed one after another, but both are typically requested and responded to synchronously.

Last updated

Was this helpful?