Skip to content

Get a workspace member

Settings module

GET/workspace-members/{id}workspaceMembers.get

A member of a workspace. Returns one workspace member with its `ETag`. A workspace member the caller may not see returns 404.

  • Requires the capability org.settings.read.
  • OAuth scopes: org.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

workspaceMembers.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the workspace member.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: WorkspaceMember

workspaceMembers.get: WorkspaceMember
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the workspace member.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
workspace_idstring (uuid)YesIdentifier of the workspace.
membership_idstring (uuid)YesIdentifier of the membership assigned to the workspace, in the same org.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "workspace_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X GET "$XOS_BASE_URL/workspace-members/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.workspaceMembers.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.workspace_members.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos workspace-members get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f