EXexcalidraw
workspace
invites

Get workspace invite

Changed on

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}

Request

  • Base URL
    https://api.excalidraw.com
  • URL
    https://api.excalidraw.com/api/v1/workspaces/invites/{inviteId}
  • Auth
    HTTP bearer

Path parameters

inviteIdstring required

Response

This response returns the data for the requested workspace invite.

idstring required
createdstring required
type'link' | 'email' required
status'pending' | 'redeemed' | 'rejected' required
emailunknown required
role'member' | 'admin' required
resolvedAtunknown required
redeemedByunknown required
usesnumber
restrictedDomainsstring[]

Changes

  • 9fa65a47c84cRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      response property email list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property redeemedBy list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property resolvedAt list-of-types was narrowed by removing types null from media type application/json of response 200