workspace

Get workspace data

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

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

creatorstring required

updaterstring required

apiVersionstring

willCancelAtstring date-time required

blockedUsersstring[]

{"stackTrail":"paths:/api/v1/workspaces:get:responses:200:content:application/json:schema:properties:type","oasType":"schema","type":"unknown"}

flagsnumber

isDeletedboolean

deletedAtnumber

Changes

No recorded changes to this endpoint across all 1 revision of this API.