Skip to content

Get an access review item

Settings module

GET/access-review-items/{id}accessReviewItems.get

One membership role to confirm or remove. Returns one access review item with its `ETag`. A access review item 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

accessReviewItems.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the access review item.
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: AccessReviewItem

accessReviewItems.get: AccessReviewItem
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the access review item.
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.
access_review_campaign_idstring (uuid)YesIdentifier of the campaign.
membership_role_idstring (uuid)YesIdentifier of the membership role.
decision"Confirmed" | "Removed" | nullYesConfirmed keeps the role; Removed ends it at once. Null while unreviewed; final once set.
decided_bystring (uuid) | nullYesIdentifier of the reviewer; null for an automatic removal.
decided_atstring (date-time) | nullYesWhen the decision was recorded.
flagged_atstring (date-time) | nullYesWhen the item was flagged as unreviewed after the grace period.
{
  "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"
}

Code samples

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