GraphQL explorer

Browse the public schema and run your first query against Carbide.

The public GraphQL API is available at:

https://app.carbide.work/graphql

Open GraphQL explorer

Run queries against your organization in Carbide’s live GraphQL explorer.

Run your first query

1. Generate an API token.
2. Open the explorer and expand Headers.
3. Add your key as {"Authorization": "Bearer carbide_YOUR_API_KEY"}.
4. Paste this read-only query and select the run button:

query RequestCount {
  listRequests(first: 10) {
    count
  }
}

A successful response has this shape; the count depends on your organization:

{
  "data": {
    "listRequests": {
      "count": 42
    }
  }
}

The explorer uses your API key’s organization when the authorization header is present. Without that header, a signed-in browser uses your current Carbide organization and user permissions instead.

Explore the schema

Use the reference in the sidebar to browse the public queries, mutations, and types. These pages are generated from Carbide’s public GraphQL schema and include arguments and example operations. To execute an operation, open the live explorer and supply your own token.

GraphQL can return errors in a JSON response even when the HTTP status is 200. Check both the top-level errors and any mutation payload’s errors before treating an operation as successful. Mutations in the explorer affect real records in your organization.