Sign in

List access requests

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns the people who asked to join the app and the people invited to it who haven't joined yet, newest first.

Check status on each entry. pending means the person asked for access and is waiting for you to approve or deny it. approved means they're invited or approved but haven't joined yet. completed means they've joined: the entry stays while they're one of the app's users, and they also appear in List app users. Requests still waiting for the person to confirm their email don't appear.

Set role to list one role only. Every matching entry comes back at once, with no paging.

<Note>This endpoint accepts a personal API key belonging to a user with access to the app. A read-only key is refused, and workspace API keys are not accepted.</Note>

get/api/apps/{app_id}/access-requests/all

Path parameters

app_idstring required

ID of the app.

ID of the app.

Query parameters

rolestring nullable

List only entries with this app role. all, or leaving it out, lists every role.

List only entries with this app role. all, or leaving it out, lists every role.

Response

The app's access requests and pending invitations.

idstring required

ID of the access request.

app_idstring required

ID of the app.

emailstring required

Email of the person.

full_namestring nullable required

Name of the person, or null when they didn't give one.

rolestring required

App role the person gets when they join.

statusstring required

pending when the person asked for access and is waiting for your review, approved when they're invited or approved but haven't joined yet, or completed once they've joined.

requested_atstring required

When the request or invitation was made, as a UTC timestamp in ISO 8601 format.

dataobject required

Custom User fields stored on the invitation, limited by the User entity's field-level read rules.

Example response

[
  {
    "id": "68d4a1f7c2b9e5001a7f3c60",
    "app_id": "6820f3a4e7b91d003c45a1f2",
    "email": "jane@acme.com",
    "full_name": "Jane Cooper",
    "role": "user",
    "status": "pending",
    "requested_at": "2026-09-20T08:12:44.201000Z",
    "data": {
      "department": "sales"
    }
  }
]

Changes

Changed in 1 of the 14 revisions of this API.1