Altium 365 API
The Altium 365 API is a GraphQL API for reading and writing Altium 365 workspace data: design projects, libraries, collaboration, procurement, supply data and more. This site is the reference for every query, mutation and type it exposes, generated nightly from the production schema.
Get started
Registering an application, obtaining an access token and calling the API for the first time are covered in the Altium Developer Center:
Regional endpoints, a first query and the Nitro and Voyager tools are in Getting started.
How this reference is organised
The API is grouped by bounded context — a business area with its own entities and vocabulary — aligned with the Common Data Model (CDM). Each context lists its queries, mutations and types. Where an API type represents a CDM entity, its page links to the entity definition.
Design Hardware projects, design data, rule checks, comparisons, releases
Collaboration Comments, annotations, tasks
Configuration Management Environment configuration; project, settings and sheet templates
Procurement Managed BOMs and BOM releases
Supply Parts, offers, part families, reference designs, evaluation kits, solution templates
Customization Extension points, scripts, workflows
System Design System design documents and system models
Requirements Requirements projects and data
Renesas (preview) Renesas-specific device models, software projects and tools
Guides
Naming conventions, Identifiers and lookups, Pagination, Errors and Lifecycle explain how the API is shaped and how to use it.
For AI assistants and code generators
Start at llms.txt: an index of the bounded contexts, each with its own llms.txt and a
compact schema.graphql slice. Every page is also available as Markdown (.md). The full schema in SDL form is
schema.graphql, regenerated together with this site; each bounded context also
publishes a smaller slice at /reference/<context>/schema.graphql.