Skip to main content
GET
/
api
/
workspaces
/
{id}
Get a workspace with all nested content
curl --request GET \
  --url https://archyon.app/api/workspaces/{id} \
  --header 'Authorization: Bearer <token>'
{
  "workspace": {
    "id": "<string>",
    "name": "<string>",
    "ownerUserId": 123,
    "properties": {},
    "createdAt": 123,
    "updatedAt": 123,
    "description": "<string>",
    "orgId": "<string>"
  },
  "components": [
    {
      "id": "<string>",
      "workspaceId": "<string>",
      "typeId": "<string>",
      "name": "<string>",
      "x": 123,
      "y": 123,
      "properties": {},
      "description": "<string>"
    }
  ],
  "relationships": [
    {
      "id": "<string>",
      "workspaceId": "<string>",
      "sourceId": "<string>",
      "targetId": "<string>",
      "typeId": "<string>",
      "properties": {},
      "label": "<string>"
    }
  ],
  "stakeholders": [
    {
      "id": 123,
      "workspaceId": "<string>",
      "componentId": "<string>",
      "linkType": "<string>",
      "properties": {},
      "createdAt": 123,
      "personId": "<string>",
      "teamId": "<string>",
      "createdBy": 123,
      "person": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>",
        "photoUrl": "<string>",
        "title": "<string>"
      },
      "team": {
        "id": "<string>",
        "name": "<string>"
      }
    }
  ],
  "processes": [
    {
      "id": "<string>",
      "workspaceId": "<string>",
      "name": "<string>",
      "mermaid": "<string>",
      "participants": {},
      "createdAt": 123,
      "updatedAt": 123,
      "description": "<string>",
      "createdBy": 123
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.archyon.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Both Clerk session JWTs (browser) and Archyon Personal Access Tokens (an_pat_…, server / CLI / MCP) use the same Bearer header. The server distinguishes them by token shape.

  • Clerk JWTs carry org context in the token claims (org_id, org_role, org_slug) — required for org-scoped endpoints. Configure your Clerk session template to include these claims; see DEPLOYMENT.md.
  • PATs are minted at /account → Tokens. Each PAT is bound to whichever org was active at mint time. Switch orgs and re-mint to address a different org.

Path Parameters

id
string
required

Workspace id (slug-like; provided at create time).

Response

OK.

workspace
object
required
components
object[]
required
relationships
object[]
required
stakeholders
object[]
required
processes
object[]
required