List entity access invites

GET

/entity-access-invites

Returns a paginated list of pending and historical member invitations for an entity, sorted by creation date (newest first).

The caller must have the can_invite_entity_member permission on the entity (granted via an administrator-tier role, or a role with a wildcard * permission); callers without it receive a 403.

Pagination is cursor-based: to retrieve the next page, pass the cursor value returned in meta.pagination.cursor from the previous response. When meta.pagination.has_more is false, you have reached the end of the list.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Responses

🟢200

application/json

A page of entity access invitations returned successfully. If there are no invitations matching the query, data will be an empty array.

Bodyapplication/json

🟠400

🟠401

🟠403

Request Example

Shell

JavaScript

Java

Swift

curl --location '/entity-access-invites?entity_id=01HZ9ABCD1234EFGH5678IJKL90&cursor=01HZ9ABCDEFGH1234567890LMNO&limit=25' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Page with results and a next cursor

{
    "message": "Entity access invites retrieved successfully",
    "status": "success",
    "data": [
        {
            "id": "01HZ9ABCDEFGH1234567890LMNO",
            "entity_id": "01HZ9ABCD1234EFGH5678IJKL90",
            "email": "jane.doe@example.com",
            "role": "finance",
            "role_name": "Finance",
            "status": "pending",
            "invited_by": "John Smith",
            "expires_at": 1723473600000,
            "created": 1722870000000
        },
        {
            "id": "01HZ9ZZZZZZZZZZZZZZZZZZZZZZ",
            "entity_id": "01HZ9ABCD1234EFGH5678IJKL90",
            "email": "amara.okoye@example.com",
            "role": "view_only",
            "role_name": "View Only",
            "status": "accepted",
            "invited_by": "John Smith",
            "expires_at": 1722960000000,
            "created": 1722860000000
        }
    ],
    "meta": {
        "pagination": {
            "cursor": "01HZ9ZZZZZZZZZZZZZZZZZZZZZZ",
            "has_more": true
        }
    }
}

Modified at 2026-09-30 00:29:30

Invite a new member to an entity

Revoke an entity access invite