Skip to content

Get an account membership role

Identity module

GET/account-membership-roles/{id}accountMembershipRoles.get

An account role held through an account membership. Returns one account membership role with its `ETag`. A account membership role the caller may not see returns 404.

  • Requires the capability me.account.write.
  • OAuth scopes: me.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

accountMembershipRoles.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the account 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: AccountMembershipRole

accountMembershipRoles.get: AccountMembershipRole
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the account membership role.
created_atstring (date-time)YesWhen the row was created.
updated_atstring (date-time)YesWhen the row was last updated.
account_membership_idstring (uuid)YesIdentifier of the account membership.
account_roleAccountRoleYesRole inside an external account.Constraints: one of "Account Owner", "Account Admin", "Account Finance", "Account Member"
granted_bystring (uuid) | nullYesIdentifier of the person who granted the role; null for the creator's own Account Owner role.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "account_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "account_role": "Account Finance",
  "granted_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

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