Docs › APIs › GraphQL

GraphQL API

Read exactly the fields you need across related records in one request, such as work orders with their asset and tasks, instead of chaining REST calls. Read-only today; it uses the same API key as the REST API.

Endpoint

Send a JSON body with query (and optionally variables) as a POST to https://api.yourredlist.com/graphql/, with the usual apiKey, vaultSecret and shardID headers. Each field is limited by the key's permissions.

Discover the schema

Download the schema to browse types, generate client code, or load it into Postman, Insomnia or GraphQL Code Generator: GET https://api.yourredlist.com/graphql/schema.graphql (or /graphql?sdl), sent with the same API key headers. Introspection queries also work.

Your first query

For the next page, pass after: "<endCursor>". The root query has a list and a by-id field for assets, asset types, asset classes, locations, regions, employees, work orders, tasks, purchase orders, purchase order products, products, vendors and part vendors. Lists that support soft delete take includeDeleted: true.

Limits

  • Page size: 50 by default, 200 max

  • Nested lists (such as workOrder.tasks): 100 per parent

  • Query depth: 10 levels

  • Execution time: 30 seconds

Queries over the cost budget are rejected before they run, with an error explaining why. Page with cursors rather than raising first.

← Previous: REST API reference Next: Webhooks →