Saltar al contenido

List account membership role rows

Módulo Identity

GET/account-membership-rolesaccountMembershipRoles.list

An account role held through an account membership. Returns a cursor page of account membership role rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

  • Requiere la capacidad me.account.write.
  • Alcances de OAuth: me.
  • Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
  • Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

accountMembershipRoles.list: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
limitLimitNoPage size. Default 50, maximum 200.Restricciones: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$
sortSortNoSort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$
filterFilterNoFilter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Respuesta 200: una página de AccountMembershipRole

accountMembershipRoles.list: AccountMembershipRole
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the account membership role.
created_atstring (date-time)SíWhen the row was created.
updated_atstring (date-time)SíWhen the row was last updated.
account_membership_idstring (uuid)SíIdentifier of the account membership.
account_roleAccountRoleSíRole inside an external account.Restricciones: one of "Account Owner", "Account Admin", "Account Finance", "Account Member"
granted_bystring (uuid) | nullSíIdentifier of the person who granted the role; null for the creator's own Account Owner role.
{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/account-membership-roles" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.accountMembershipRoles.listAll()) {
  console.log(row);
}
for row in xos.account_membership_roles.list_all():
    print(row)
xos account-membership-roles list --all