Skip to main content

GraphQL reference

The full GraphQL schema is composed from 40+ services via federation. The composed live API schema is the canonical reference.

Live schema​

Browse the live schema:

  • Public (workspace layer): https://graphqlworkspaces.burdenoff.com/workspaces/graphql — open in any GraphQL client (GraphiQL, Insomnia, Postman)
  • Public (global layer): https://graphql.burdenoff.com/global/graphql

In production, the gateway exposes GraphiQL only when authenticated. Use your developer-issued token.

Schema registry​

The composed live API schema is published to the schema registry. If you have a Hive account, you can browse:

  • Workspaces / production: the live registry
  • Global / production: burdenoff/global/production

Auto-generated typed clients (TypeScript, Python) ship as part of our Node SDK and Python SDK.

What you'll find​

  • Queries — read operations (me, myWorkspaces, tag, ...)
  • Mutations — write operations (createWorkspace, sendMessage, ...)
  • Subscriptions — live updates over WebSocket
  • Directives — @rbac, @usage, @requiresAuth

Conventions​

ConventionExample
my* queries return resources the caller ownsmyWorkspaces, mySessions
all* queries return everything in scope (admin)allUsers, allRoles
Connection types follow Relay specConversationConnection { edges, pageInfo }
Flat lists use Connection without RelayAppConnection { apps, hasMore, totalCount }

Next steps​