GraphQL Endpoint

curl --request POST \
  --url https://app.speckle.systems/graphql \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "query { activeUser { id name email } }"
}'

{
  "data": {
    "activeUser": {
      "id": "user-id",
      "name": "John Doe",
      "email": "[email protected]"
    }
  }
}

POST

graphql

GraphQL Endpoint

curl --request POST \
  --url https://app.speckle.systems/graphql \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "query { activeUser { id name email } }"
}'

{
  "data": {
    "activeUser": {
      "id": "user-id",
      "name": "John Doe",
      "email": "[email protected]"
    }
  }
}

Full Schema Documentation

The complete GraphQL schema with all types, queries, mutations, and subscriptions is available in Apollo Studio.

Example Query

query {
  activeUser {
    id
    name
    email
  }
}

Additional Resources

Apollo Studio - Speckle Server API - Interactive schema explorer
Apollo Studio - API Changelog - Track API changes
GraphQL Official Documentation - Learn GraphQL fundamentals

Authorizations

Authorization

string

header

required

Personal access token. Get your token from your Speckle profile settings.

Body

application/json

query

string

required

The GraphQL query string

variables

object

Variables for the query

operationName

string

Optional name of the operation to execute

Response

GraphQL response containing data and/or errors

data

object

The response data

errors

object[]

Array of errors, if any

Show child attributes

GraphQL API REST API

⌘I

GraphQL

REST

Guides

​Full Schema Documentation

​Example Query

​Additional Resources

Authorizations

Body

Response

Full Schema Documentation

Example Query

Additional Resources