The Workspace Report API lists all workspaces created in your organization. Company admins can access the API using the API keys generated from their company dashboard.

Note: Some attributes may not be returned if they do not contain a value.

List of attributes response:
workspaceId
Unique ID of the workspace.
workspaceName
Name of the workspace.
workspaceUrl
Workspace URL.
plan
Types of plans:
- Free Trial
- Enterprise
dateCreated
Date when the workspace was created.
creatorId
Unique ID of the user who created the workspace.
creatorEmail
Email address of the user who created the workspace.
workspaceStatus
Boolean. When true, the workspace has never been used.
deleted
Boolean. When true, the workspace is deleted.
dateDeleted
Date when the workspace was deleted.
deletedUserId
Unique ID of the user who deleted the workspace.
suspended
Boolean. When true, the workspace is suspended.
dateSuspended
Date when the workspace was suspended.
suspendedUserId
Unique ID of the user who suspended the workspace.
ownerId
Unique ID of the user who owns the workspace.
ownerIdEmail
Email address of the user who owns the workspace.
allowGuests
Boolean. When true, the workspace allows guests.
allowVisitors
Boolean. When true, the workspace allows visitors.
memberCount
Number of members in the workspace.
guestCount
Number of guests in the workspace.
Language
Authentication
Header
Click Try It! to start a request and see the response here!