EXexcalidraw
workspace

Get workspace data

Changed on

Retrieve the current workspace's metadata, including users and invites.

This endpoint returns:
- Workspace name, settings, and configuration
- List of user IDs in the workspace
- Workspace invite information

**Use cases:**
- Displaying workspace details in dashboards
- Fetching workspace data for integrations
- Validating workspace context for user actions
get/api/v1/workspaces

Request

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

Response

This response returns the data for the current workspace.

idstring required
usersstring[] required
rolesobject required
namestring required
createdstring date-time required
picturestring uri required
subscriptionStatus'payment_failed' | 'active' | 'canceled' | 'trialing' | 'overdue' required
creatorunknown required
updaterunknown required
apiVersionstring
willCancelAtstring date-time required
blockedUsersstring[]
typeunknown
flagsnumber
isDeletedboolean
deletedAtnumber

Changes

  • 9fa65a47c84cRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

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

    • info

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

    • info

      the response's property pattern was changed from ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ to ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ for the status

    • info

      the / response's property pattern was changed from ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ to ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ for the status