Management APIs / Members

Get a member

GEThttps://api.spice.ai/v1/members/{memberId}

Returns details for a specific organization member, including their roles.

Authorizations

  • AuthorizationstringRequired

    Bearer <token>. Authentication lists the tokens it accepts.

Path parameters

  • memberIdintegerRequired

    The user ID of the member

Header parameters

  • X-Org-Namestring

    The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but GET /v1/orgs (400 org_assertion_required otherwise).

    • Pattern: ^[A-Za-z0-9._-]{1,255}$

Responses

200Member detailsapplication/json

  • user_idinteger

  • usernamestring

  • rolesarray of string

  • is_ownerboolean

  • created_atstring (date-time)

401Unauthorized

403Insufficient scope

404Member not found

curl "https://api.spice.ai/v1/members/<memberId>" \
  -H "Authorization: Bearer <token>"
{
  "user_id": 0,
  "username": "string",
  "roles": [
    "string"
  ],
  "is_owner": true,
  "created_at": "2026-01-01T00:00:00Z"
}

application/json

GEThttps://api.spice.ai/v1/orgs/{orgId}/members/{memberId}

The org is orgId in the path. Returns details for a specific organization member, including their roles.

Authorizations

  • AuthorizationstringRequired

    Bearer <token>. Authentication lists the tokens it accepts.

Path parameters

  • orgIdintegerRequired

    The org id from GET /v1/orgs

    • Minimum: 1

  • memberIdintegerRequired

    The user ID of the member

Header parameters

  • X-Org-Namestring

    When present, X-Org-Name must name the same org as orgId. Otherwise the request returns org_path_mismatch (400).

    • Pattern: ^[A-Za-z0-9._-]{1,255}$

Responses

200Member detailsapplication/json

  • user_idinteger

  • usernamestring

  • rolesarray of string

  • is_ownerboolean

  • created_atstring (date-time)

400Bad Request

orgId is not a valid org id (invalid_org_id), or X-Org-Name does not name that org (org_path_mismatch).

401Unauthorized

403Forbidden

Insufficient scope. The caller is not a member of the org (org_forbidden). A machine credential named a different org (org_assertion_mismatch). The org is deleted (org_deleted).

404Member not found

OpenAPIapi.spice.ai/openapi.json

curl "https://api.spice.ai/v1/orgs/<orgId>/members/<memberId>" \
  -H "Authorization: Bearer <token>"
{
  "user_id": 0,
  "username": "string",
  "roles": [
    "string"
  ],
  "is_owner": true,
  "created_at": "2026-01-01T00:00:00Z"
}

application/json