GraphQL API

Learn about building apps and integrations on top of CalcTree's API

Endpoint

CalcTree's GraphQL endpoint is:

https://graph.calctree.com/graphql

Authentication

Right now we support personal API keys for authentication. Check out this page to see how to create one.

Headers for your api calls should look like this:

headers: {
          "Content-Type": "application/json",
          "x-api-key": apiKey,
        }

Page & Workspace IDs

You'll need your page and workspace IDs to connect to pages in your workspace from an external tool. Both can be found in the URL of a page, which take the form:

https://app.staging.calctree.com/edit/workspaceID/pageID

Page ID

As well as in the page URL, you can find your pageID on the RHS integrations pane of your page.

Workspace ID

Your workspaceID can be found in the URL of the page you're in, in a given workspace. For example, for this URL:

https://app.calctree.com/edit/ae3d7998-a4c7-41c1-abfd-fb3f07a80f21/ilxbKtbDgAHQWimUKM3bh

The workspaceID would be ae3d7998-a4c7-41c1-abfd-fb3f07a80f21.

Queries and Mutations

The API allows for two different types of calls, queries and mutations.

Queries

Query API calls let you inspect elements in CalcTree, mainly data and calculations (pages). See this page for details and examples of available queries.

Mutations

Mutation type API calls allow you to manipulate data on CalcTree. Uploading files, editing parameter inputs and defining new pages and statements are some examples.

See this page for details and examples of available mutations.