Altium 365 API Quick Start Guide

Altium 365 API gives you programmatic access to your Workspace data – projects, BOMs, components, symbols, footprints, and more. It is a GraphQL API, meaning you can query exactly the data you need in a single request.

This guide gets you from zero to your first API call in minutes.

Prerequisites

• An Altium 365 Workspace

• A Workspace admin account

• An account on Altium Developer Center – Altium's self-service portal for developers, where you can enroll in programs to access Altium 365 API, Altium Designer SDK, Embeddable Viewer, and other developer products

Step 1: Create a Token

To authorize API requests, you need an access token. Tokens are created in your Workspace under Admin → Developer.

When creating a token, you can choose between the following two options.

Option A: Long-lived Access Token

The simplest way to get started. You receive a single access token with a configurable lifetime (up to 1 year). Use it directly in API requests.

Good for: quick exploration, scripts, and integrations where simplicity is the priority.

See Using an Access token for details.

Option B: Refresh Token (Recommended for Production)

A more secure approach. You receive a refresh token along with a client ID and client secret. The refresh token is exchanged programmatically for a short-lived access token, which is then used in API requests. The refresh token itself has a configurable lifetime (up to 1 year).

Good for: automated integrations, background services, and anything running in production 24/7.

See Using a Refresh Token for the exchange flow.

Step 2: Make Your First API Request

The fastest way to explore Altium 365 API is through the built-in browser IDE (powered by Nitro). Navigate to:

https://{workspace-domain}.altium.com/svc/napi/gateway/graphql/

Replace {workspace-domain} with your actual Workspace domain (for example, mycompany.altium.com).

Authorize Your Request

All API requests require an access token passed in Authorization HTTP header with Bearer scheme:

Authorization: Bearer {access-token}

Run Your First Query

A good starting query is to list your Workspace projects:

query {
  desProjects(first: 10) {
    nodes {
      id
      name
      description
    }
  }
}

Paste it into the IDE, click Run, and you should see your Workspace projects in the response.

You can also explore the full API schema visually at:

https://{workspace-domain}.altium.com/svc/napi/gateway/voyager/

Next Steps

• Browse the AltiumDeveloper GitHub organization for demo apps and example queries

• See Using an Access Token for using tokens in code and scripts

• See Using a Refresh Token for automated integrations