API Quickstart

Integrate Aurora WorkOS without guessing at IDs or workflow state.

The external API is workspace-scoped, token-authenticated, and designed to support automation clients that need stable discovery, resilient create flows, and clean machine-readable responses.

Quickstart flow

1Create an API token from Settings → Admin → Integrations.
2Call GET /api/external to verify authentication and discover capabilities.
3Call GET /api/external/teams, /users, and /statuses to map the workspace.
4Create projects and issues with stable keys and idempotency keys.

Auth example

TOKEN="aurora_pat_your_token_here"

curl https://www.auroraworkos.com/api/external \
  -H "Authorization: Bearer $TOKEN"

Use `Idempotency-Key` on create routes and `teamKey` / `projectKey` whenever your client can avoid opaque IDs.

Discovery

/api/external
/api/external/teams
/api/external/users
/api/external/statuses

Projects

/api/external/projects
/api/external/projects/{projectId}
/api/external/projects/by-key/{teamKey}/{projectKey}

Issues

/api/external/issues
/api/external/issues/{issueId}
/api/external/issues/by-key/{issueKey}

Need the full integration contract?

Move into the developer guide for cursor pagination, structured error codes, by-key lookup routes, and retry-safe create semantics for agents and backend workflows.

Open developer guide