List Workspace Invitations

GET/web/v1/workspaces/{workspaceBizId}/invitations JWT

Lists all invitations for a workspace with optional filters. Supports filtering by status, invitee email, and creation date range.

Required Headers

Header	Example Value	Description
Content-Type	application/json	Request content type
Accept	application/json	Expected response type
X-Client-Hash		Client device fingerprint
Accept-Language	en, zh, zh-Hant, ja, vi	Response language (default: en)
Authorization	Bearer	JWT access token
X-Workspace-Id		Target workspace ID

Request Parameters

Name	Type	Required	In	Description
workspaceBizId	String	Required	path	Business ID of the workspace
statuses	Array<Integer>	Optional	query	Filter by invitation status codes (e.g. 10011001 for PENDING)
inviteeEmail	String	Optional	query	Filter by invitee email address
createdAtFrom	String (ISO 8601)	Optional	query	Filter invitations created after this timestamp
createdAtTo	String (ISO 8601)	Optional	query	Filter invitations created before this timestamp

Success Response

Status: 200 OK

Returns an array of invitation objects.

Success 200

{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": [
    {
      "bizId": "inv_abc123def456",
      "workspaceBizId": "WS_INVITE_TEST_001",
      "workspaceName": "Test Workspace",
      "inviterBizId": "ACC_OWNER_001",
      "inviterName": "Owner User",
      "inviteeEmail": "invitee@example.com",
      "inviteeAccountBizId": "ACC_INVITEE_001",
      "inviteeAccountName": null,
      "invitationStatus": {
        "value": 10011001,
        "name": "PENDING",
        "code": "PENDING"
      },
      "message": "Welcome to our workspace",
      "expiresAt": "2026-03-29T10:30:00Z",
      "acceptedAt": null,
      "createdAt": "2026-03-22T10:30:00Z",
      "canAccept": true
    }
  ]
}

Response Item Fields

Field	Type	Description
bizId	String	Unique invitation business ID
workspaceBizId	String	Target workspace business ID
workspaceName	String	Target workspace display name
inviterBizId	String	Inviter's account business ID
inviterName	String	Inviter's display name
inviteeEmail	String	Invitee's email address
inviteeAccountBizId	String	Invitee's account ID (if registered)
inviteeAccountName	String	Invitee's display name (nullable)
invitationStatus	Object	Status enum: PENDING, ACCEPTED, CANCELLED, DECLINED, EXPIRED
message	String	Invitation message
expiresAt	String	ISO 8601 expiration timestamp
acceptedAt	String	ISO 8601 acceptance timestamp (nullable)
createdAt	String	ISO 8601 creation timestamp
canAccept	Boolean	Whether the invitation can still be accepted

Error Responses

Unauthorized 401

{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}

Notes

• Requires workspace:invitation:read permission.
• All query filters are optional and can be combined.
• Returns an empty array [] when no invitations match.