GET
/
workspaces
curl --request GET \
  --url https://api.mudstack.com/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'x-account-id: <x-account-id>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "thumbnail_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "defaultAvatar": 1,
  "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sequence": "<string>",
  "roles": {
    "workspace_id": "<string>",
    "user_id": "<string>",
    "roles": [
      "<string>"
    ],
    "user": {
      "id": "<string>",
      "auth0UserID": "<string>",
      "username": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "avatar_file_id": "<string>",
      "defaultAvatar": 123,
      "industry": "<string>",
      "occupation": "<string>",
      "company": "<string>",
      "emailVerified": true,
      "isActive": true,
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "zipCode": "<string>",
      "invited_by_user": {}
    }
  },
  "usage": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-account-id
string
required
​
x-workspace-id
string
required

Response

200 - application/json
Successfully retrieved workspace details
​
id
string

Unique identifier for the workspace.

​
account_id
string

Unique identifier for the account associated with the workspace.

​
name
string

Name of the workspace.

​
thumbnail_file_id
string

Unique identifier for the thumbnail file associated with the workspace.

​
defaultAvatar
integer
default:1

Default avatar for the workspace.

Required range: 1 <= x <= 10
​
created_by_user_id
string

Unique identifier for the user who created the workspace.

​
sequence
string

Sequence number for the workspace.

​
roles
object

Roles associated with the workspace.

​
usage
object

Usage information for the workspace.

Was this page helpful?