Altium 365 API
Altium 365 API is a GraphQL API that provides programmatic access to your Altium 365 Workspace data. It supports both read and write operations across the full breadth of the platform.
How the API is Organized
The API is structured around the platform's domain areas, known as bounded contexts. Each bounded context covers a specific area of the platform – its entities, operations, and business rules. GraphQL type and query names follow naming conventions that reflect the domain area they belong to, making it easier to navigate the schema once you're familiar with the structure.
Main Bounded Contexts
Bounded Context |
What it Covers |
Design |
PCB projects, schematics, variants, releases, manufacturing packages |
Library |
Components, symbols, footprints, parts, part requests, datasheets |
Procurement |
Bills of materials, BOM items, alternative and substitute parts |
Platform |
Users, Workspaces, organizations, lifecycle definitions, revision naming |
Collaboration |
Comments, comment threads, tasks |
Customization |
Workflows, scripts, script executions |
Additional bounded contexts cover more specialized capabilities – device modeling, over-the-air firmware updates, requirements management, embedded software, and system design. These are accessible through the same API and follow the same conventions.
Each bounded context will have its own dedicated documentation section as coverage expands. The built-in Voyager schema browser is a good way to explore the full type graph in the meantime.
Endpoints
Regional Endpoints
Use a regional endpoint when you don't have a Workspace in scope – for example, to list all Workspaces a user has access to – or when working with global data such as users and organizations.
Region |
GraphQL |
Files Service |
Voyager (schema exploration) |
Europe |
|
|
https://eur.365.altium.com/api/voyager |
US West |
|
|
https://usw.365.altium.com/api/voyager |
US East |
|
|
https://use.365.altium.com/api/voyager |
Asia Pacific |
|
|
https://asp.365.altium.com/api/voyager |
GovCloud |
|
|
https://use.365-gov.altium.com/api/voyager |
Workspace Endpoints
Workspace endpoints is the recommended starting point to interact with workspace-specific resources. API endpoints use the same workspace domain and can be programmatically discovered - see List Workspaces example.
GraphQL |
Files Service |
Voyager (schema exploration) |
|
|
https://{workspace-domain}/api/voyager |
Exploring the Schema
Altium 365 API is self-documenting. Two built-in tools are available directly from your Workspace URL:
-
Nitro – a browser-based GraphQL IDE for writing and running queries interactively:
https://{workspace-domain}/api/graphql/ -
Voyager – a visual graph of the complete schema, useful for understanding relationships between types:
https://{workspace-domain}/api/voyager/
Authentication
All requests must include a valid access token:
Authorization: Bearer {access-token}
See Using an Access Token for details.
In This Section