Identity

Read the signed-in user: GET /me
Read an organization: GET /organizations/{orgID}
List an organization’s members: GET /organizations/{orgID}/members

Read the signed-in user

GET /me

API: Business. Permission: none. Any signed-in person can call it. Returns your user record and every organization you are an active member of. This is the usual first call: it gives you the organization IDs every other endpoint needs. If your sign-in domain is set up to join an organization automatically, the first call creates that membership.

Response

Field	Type	Description
`user.id`	string	Your user ID, `user_` + ULID.
`user.primary_email`	string	Your email address, lowercased.
`user.display_name`	string	Your display name.
`user.preferred_username`	string, optional	The username your identity provider asserted, if any. Not your cluster username.
`user.login_shell`	string	Your personal gateway login shell, `/bin/bash` by default. Change it with `PUT /me/login-preferences`.
`user.lifecycle_state`	string	Always `active` here.
`user.created_at`, `user.updated_at`	timestamp	RFC 3339 timestamps.
`memberships`	array	Your active memberships. Empty if you belong to no organization.
`memberships[].org_id`	string	The organization ID, `org_` + ULID.
`memberships[].role`	string	`owner`, `admin`, or `member`. See Permissions.
`memberships[].organization_username.username`	string	Your login name on this organization’s clusters.
`memberships[].organization_username.lifecycle_state`	string	`reserved` until first used on a cluster, then `frozen`.
`memberships[].user_id`, `.email`, `.lifecycle_state`, `.created_at`, `.updated_at`		Membership details. `lifecycle_state` is always `active` here.
`default_org_id`	string, optional	The organization to use when there is an obvious choice. Absent when you must choose between several.
`staff_keys`	array of strings	Andromeda staff permissions. Empty for customers.

Memberships carry no organization name. Call GET /organizations/{orgID} for that.

Example

andromeda call business GET /me

{
  "user": {
    "id": "user_01J8Z3Q4R5S6T7V8W9X0Y1Z2A4",
    "primary_email": "ada@example.com",
    "display_name": "Ada Lovelace",
    "login_shell": "/bin/bash",
    "lifecycle_state": "active",
    "created_at": "2026-09-01T12:00:00Z",
    "updated_at": "2026-09-01T12:00:00Z"
  },
  "memberships": [
    {
      "org_id": "org_01J8Z3Q4R5S6T7V8W9X0Y1Z2A3",
      "user_id": "user_01J8Z3Q4R5S6T7V8W9X0Y1Z2A4",
      "email": "ada@example.com",
      "role": "member",
      "lifecycle_state": "active",
      "organization_username": {
        "id": "org_username_01J8Z3Q4R5S6T7V8W9X0Y1Z2A6",
        "org_id": "org_01J8Z3Q4R5S6T7V8W9X0Y1Z2A3",
        "user_id": "user_01J8Z3Q4R5S6T7V8W9X0Y1Z2A4",
        "username": "ada",
        "source": "local",
        "lifecycle_state": "frozen",
        "created_at": "2026-09-01T12:00:00Z",
        "frozen_at": "2026-09-02T08:15:00Z"
      },
      "created_at": "2026-09-01T12:00:00Z",
      "updated_at": "2026-09-01T12:00:00Z"
    }
  ],
  "default_org_id": "org_01J8Z3Q4R5S6T7V8W9X0Y1Z2A3",
  "staff_keys": []
}

Errors

Status	Code	When
401	`unauthorized`	No valid token, a service-account token, or no Andromeda account exists for this identity.
503	`integration_unavailable`	Temporary. Retry.

Read an organization

GET /organizations/{orgID}

API: Business. Permission: none. You must be an active member.

Parameters

Name	In	Type	Required	Description
`orgID`	path	string	yes	Organization ID, `org_` + ULID.

Response

Field	Type	Description
`id`	string	Organization ID.
`slug`	string	Stable URL-safe name.
`display_name`	string	Human-readable name.
`lifecycle_state`	string	Organization state.
`created_by_user_id`	string	User who created the organization.
`created_at`, `updated_at`	timestamp	RFC 3339 timestamps.

Example

andromeda call business GET "/organizations/$ORG_ID"

{
  "id": "org_01J8Z3Q4R5S6T7V8W9X0Y1Z2A3",
  "slug": "analytical-engines",
  "display_name": "Analytical Engines",
  "lifecycle_state": "active",
  "created_by_user_id": "user_01J8Z3Q4R5S6T7V8W9X0Y1Z2A7",
  "created_at": "2026-08-20T09:00:00Z",
  "updated_at": "2026-08-20T09:00:00Z"
}

Errors

Status	Code	When
404	`not_found`	The organization does not exist, or you are not a member of it.

List an organization’s members

GET /organizations/{orgID}/members

API: Business. Permission: none. You must be an active member. Returns every active member, oldest membership first. Use it to find a colleague’s user ID from their email address, for example before replacing their permissions. The list is not paginated.

Parameters

Name	In	Type	Required	Description
`orgID`	path	string	yes	Organization ID, `org_` + ULID.

Response

Field	Type	Description
`members[].user_id`	string	The member’s user ID, `user_` + ULID.
`members[].email`	string	The member’s email address.
`members[].role`	string	`owner`, `admin`, or `member`.
`members[].organization_username.username`	string	The member’s login name on this organization’s clusters.
`members[].org_id`, `.lifecycle_state`, `.created_at`, `.updated_at`		Membership details, as in `GET /me`.

Example

andromeda call business GET "/organizations/$ORG_ID/members" | jq -c '.members[] | {user_id, email, role}'

{"user_id":"user_01J8Z3Q4R5S6T7V8W9X0Y1Z2A7","email":"grace@example.com","role":"owner"}
{"user_id":"user_01J8Z3Q4R5S6T7V8W9X0Y1Z2A4","email":"ada@example.com","role":"member"}

Errors

Status	Code	When
404	`not_found`	The organization does not exist, or you are not a member of it.

Overview

Business API

Platform API

Read the signed-in user

Response

Example

Errors

Read an organization

Parameters

Response

Example

Errors

List an organization’s members

Parameters

Response

Example

Errors

​Read the signed-in user

​Response

​Example

​Errors

​Read an organization

​Parameters

​Response

​Example

​Errors

​List an organization’s members

​Parameters

​Response

​Example

​Errors

Read the signed-in user

Response

Example

Errors

Read an organization

Parameters

Response

Example

Errors

List an organization’s members

Parameters

Response

Example

Errors