Skip to content

Get a membership role

Identity module

GET/membership-roles/{id}membershipRoles.get

A role held through a membership. A person may hold several; capabilities are the union. A person cannot grant themselves a role. Returns one membership role with its `ETag`. A membership role the caller may not see returns 404.

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

Path and query parameters

membershipRoles.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the membership role.
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: MembershipRole

membershipRoles.get: MembershipRole
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the membership role.
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.
membership_idstring (uuid)YesIdentifier of the membership.
role_idstring (uuid)YesIdentifier of the held role: a system role or a custom role of the same org.
granted_bystring (uuid) | nullYesIdentifier of the person accountable for the grant; null when the platform granted the first Owner of a new 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",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "granted_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

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