Get workspace invite

Retrieve details for a specific workspace invite by its ID.

This endpoint returns all metadata for the invite, including status and restrictions.

Use cases:

  • Displaying invite details in UI
  • Validating invite status before accepting
  • Auditing invite usage
GET
/api/v1/workspaces/invites/{inviteId}
AuthorizationBearer <token>

The API will use the Authorization: Bearer <your-key> header for requests.

In: header

Path Parameters

inviteId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.excalidraw.com/api/v1/workspaces/invites/string"
{
  "id": null,
  "created": "string",
  "type": "link",
  "status": "pending",
  "email": "string",
  "role": "member",
  "resolvedAt": "string",
  "redeemedBy": "string",
  "maxUses": 9007199254740991,
  "uses": 0,
  "restrictedDomains": [
    "string"
  ]
}
{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "string"
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "string"
}
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "string"
}