Skip to main content

​
Overview

The Speckle Server provides a comprehensive GraphQL API that powers most interactions with your data. The complete, up-to-date API reference is available through Apollo Studio.

​
Documentation

Access the full GraphQL API reference at: Apollo Studio - Speckle Server API This interactive documentation provides:
  • Complete Schema: Browse the entire GraphQL schema with detailed descriptions for all types, queries, mutations, and subscriptions
  • Field Documentation: Inline documentation for every field, argument, and return type
  • Interactive Explorer: Test queries directly in your browser with the built-in GraphQL explorer
  • Type Definitions: Full type definitions and relationships between objects

​
Changelog

The Apollo Studio reference also includes a changelog that tracks all changes to the GraphQL API. This allows you to:
  • Stay informed about new features and capabilities
  • Track breaking changes and deprecations
  • Plan updates to your integrations
  • Review the evolution of the API over time
Access the full changelog at: Apollo Studio - API Changelog

​
Using the API

​
Authentication

To authenticate your GraphQL requests, you’ll need a personal access token. Include it in your requests: 
Authorization: Bearer YOUR_TOKEN

​
Endpoint

The GraphQL endpoint for app.speckle.systems is: 
https://app.speckle.systems/graphql
For self-hosted instances, replace the domain with your server’s address.

​
Example Query

Here’s a simple example query to get started: 
query {
  activeUser {
    id
    name
    email
  }
}

​
Additional Resources