workspace
invites

Get workspace invites

Changed on

Retrieve a paginated list of invites for the current workspace.

This endpoint allows you to:
- List all pending and active invites
- Paginate through large invite lists

**Use cases:**
- Managing workspace invitations
- Displaying invite status in UI
- Auditing workspace access
get/api/v1/workspaces/invites

Request

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

Query parameters

limitinteger

The number of items to return per page.

offsetinteger

The number of items to skip before starting to collect the result set.

Response

This response returns a paginated list of workspace invites.

limitnumber required

The maximum number of items to return.

offsetnumber required

The number of items to skip before starting to collect the result set.

hasNextPageboolean required

Indicates if there are more pages available.

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 data/items/email list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

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

    • info

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