Sign in
access-reviews

Get access inventory for compliance reviews

Returns a comprehensive view of all users and their access rights across organizations and projects. This endpoint supports compliance requirements for access reviews (SOC 2, ISO 27001).

The response includes:

  • User details (id, email, name, external_id)
  • Organization memberships with roles and grant dates
  • Project memberships with roles and grant dates
  • API key summary (active, revoked, expired counts)
  • Last activity timestamp
  • Summary statistics

Use format=csv for CSV export suitable for auditors and spreadsheets.

get/admin/v1/access-reviews/inventory

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /admin/v1/access-reviews/inventory
  • Auth: HTTP bearer

Query parameters

org_idstring uuid nullable

Filter by organization ID

limitinteger

Maximum number of users to return (default: 100, max: 1000)

offsetinteger

Offset for pagination

format'json' | 'csv'

Export format for access review reports

Export format (json or csv)

Response

Access inventory (JSON or CSV based on format parameter)

generated_atstring date-time required

When this inventory was generated

total_usersinteger required

Total number of users in the system

Changes

No recorded changes to this operation across all 1 revision of this API.