get https://api.mural.co/enterprise/v1/reports/workspaces
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. Use filter parameters to narrow the API results.
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:
- Annual
- Business
- Education
- Enterprise
- Free
- Monthly
- Partner
- Student
- Other - 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
- Types of statuses:
- Active: A workspace that allows users to generate, modify, and remove content within it.
- Inactive: A workspace suspended by an administrator. This workspace disallows the access, creation, modification, or deletion of content within it.
- Expired: A workspace that, while not deleted or suspended, has surpassed its expiration date and disallows the access, creation, modification, or deletion of content within it.
- Removed: A workspace deleted by an administrator. This workspace contains no rooms or murals and is inaccessible to platform users; however, it is retained in reports solely for historical reference. - 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.
- ownerEmail
- 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.