List all invitations

Testing

GET

/v2/workspaces/invitations

List all workspace invitations (pending, accepted, rejected, revoked)

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.zapmail.ai/api/v2/workspaces/invitations?limit=10&page=1&status=PENDING' \
--header 'x-auth-zapmail: YOUR_API_KEY' \
--header 'x-workspace-key: workspace_id'

Responses

🟢200Success

application/json

Body

Example

{
  "status": 200,
  "message": "Invitations fetched successfully",
  "data": {
    "page": 1,
    "limit": 10,
    "totalCount": 5,
    "totalPages": 1,
    "invitations": [
      {
        "id": "invitation_uuid",
        "workspaceId": "workspace_uuid",
        "workspaceName": "My Workspace",
        "inviteeEmail": "user@example.com",
        "role": "EDITOR",
        "status": "PENDING",
        "expiresAt": "2026-01-17T10:30:00Z",
        "acceptedAt": null,
        "sender": {
          "email": "owner@example.com",
          "firstName": "Owner",
          "lastName": "User"
        }
      }
    ]
  }
}

Modified at 2026-01-15 09:35:45

Send invitiation to join workspace

Revoke invitation