Saltar al contenido

List access review item rows

Módulo Settings

GET/access-review-itemsaccessReviewItems.list

One membership role to confirm or remove. Returns a cursor page of access review item rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

  • Requiere la capacidad org.members.read.
  • Alcances de OAuth: org.
  • 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

accessReviewItems.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 AccessReviewItem

accessReviewItems.list: AccessReviewItem
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the access review item.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
access_review_campaign_idstring (uuid)SíIdentifier of the campaign.
membership_role_idstring (uuid)SíIdentifier of the membership role.
decision"Confirmed" | "Removed" | nullSíConfirmed keeps the role; Removed ends it at once. Null while unreviewed; final once set.
decided_bystring (uuid) | nullSíIdentifier of the reviewer; null for an automatic removal.
decided_atstring (date-time) | nullSíWhen the decision was recorded.
flagged_atstring (date-time) | nullSíWhen the item was flagged as unreviewed after the grace period.
{
  "data": [
    {
      "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",
      "access_review_campaign_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "membership_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "decision": "Confirmed",
      "decided_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "decided_at": "2026-10-08T14:30:00Z",
      "flagged_at": "2026-10-08T14:30:00Z"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/access-review-items" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.accessReviewItems.listAll()) {
  console.log(row);
}
for row in xos.access_review_items.list_all():
    print(row)
xos access-review-items list --all