GET
/
workspace
/
folders
curl --request GET \
  --url https://api.mudstack.com/workspace/folders \
  --header 'Authorization: Bearer <token>' \
  --header 'x-account-id: <x-account-id>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "id": "<string>",
  "workspace_id": "<string>",
  "name": "<string>",
  "asset_type_id": "<string>",
  "status_id": "<string>",
  "isActive": true,
  "created_by_user_id": "<string>",
  "locked_by_user_id": "<string>",
  "file_name": "<string>",
  "file_location": "<string>",
  "current_version_id": "<string>",
  "sequence": 123,
  "currentVersion": {
    "id": "<string>",
    "asset_id": "<string>",
    "commit_parent_id": "<string>",
    "created_by_user_id": "<string>",
    "thumbnail_file_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "key": "<string>",
    "size": 123,
    "version_number": 123,
    "sequence": 123,
    "checksum": "<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": {}
    }
  },
  "version": {
    "id": "<string>",
    "asset_id": "<string>",
    "commit_parent_id": "<string>",
    "created_by_user_id": "<string>",
    "thumbnail_file_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "key": "<string>",
    "size": 123,
    "version_number": 123,
    "sequence": 123,
    "checksum": "<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": {}
    }
  },
  "versions": [
    {
      "id": "<string>",
      "asset_id": "<string>",
      "commit_parent_id": "<string>",
      "created_by_user_id": "<string>",
      "thumbnail_file_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "key": "<string>",
      "size": 123,
      "version_number": 123,
      "sequence": 123,
      "checksum": "<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": {}
      }
    }
  ],
  "collaborators": [
    {
      "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": {}
    }
  ],
  "favorited": true,
  "tags": [
    {
      "id": "<string>",
      "workspace_id": "<string>",
      "name": "<string>",
      "color": "<string>",
      "created_by_user_id": "<string>",
      "sequence": 123
    }
  ],
  "libraries": [
    {
      "id": "<string>",
      "workspace_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "thumbnail_file_id": "<string>",
      "defaultAvatar": 123,
      "created_by_user_id": "<string>",
      "sequence": 123
    }
  ],
  "reviewRequests": [
    {
      "workspace_id": "<string>",
      "asset_id": "<string>",
      "asset_version_id": "<string>",
      "requestor_id": "<string>",
      "user_id": "<string>",
      "review_id": "<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": {}
      },
      "requestor": {
        "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": {}
      },
      "asset": {},
      "version": {
        "id": "<string>",
        "asset_id": "<string>",
        "commit_parent_id": "<string>",
        "created_by_user_id": "<string>",
        "thumbnail_file_id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "key": "<string>",
        "size": 123,
        "version_number": 123,
        "sequence": 123,
        "checksum": "<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": {}
        }
      },
      "review": {
        "id": "<string>",
        "asset_id": "<string>",
        "asset_version_id": "<string>",
        "user_id": "<string>",
        "assigned_user_id": "<string>",
        "status": "approved",
        "content": "<string>",
        "mentions": [
          "<string>"
        ],
        "viewer_metadata": {},
        "attachments": [
          {
            "id": "<string>",
            "asset_id": "<string>",
            "created_by_user_id": "<string>",
            "file_id": "<string>",
            "thumbnail_file_id": "<string>",
            "review_id": "<string>",
            "comment_id": "<string>",
            "name": "<string>",
            "description": "<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": {}
            }
          }
        ],
        "version": {
          "id": "<string>",
          "asset_id": "<string>",
          "commit_parent_id": "<string>",
          "created_by_user_id": "<string>",
          "thumbnail_file_id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "key": "<string>",
          "size": 123,
          "version_number": 123,
          "sequence": 123,
          "checksum": "<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": {}
          }
        },
        "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": {}
        },
        "assignee": {
          "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": {}
        },
        "workspace_id": "<string>"
      }
    }
  ],
  "assetType": {
    "id": "<string>",
    "name": "<string>",
    "displayType": "<string>",
    "color": "<string>",
    "generic": true,
    "knownExtensions": [
      "<string>"
    ]
  },
  "assetStatus": {
    "id": "<string>",
    "workspace_id": "<string>",
    "name": "<string>",
    "color": "<string>",
    "rank": "<string>",
    "created_by_user_id": "<string>"
  }
}

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

Query Parameters

​
folder
string
required

The path of the folder to retrieve.

Response

200 - application/json
Folder details retrieved successfully.
​
id
string

Unique identifier for the asset

​
workspace_id
string

Identifier for the workspace to which the asset belongs

​
name
string

Name of the asset

​
asset_type_id
string

Identifier for the type of the asset

​
status_id
string

(Optional) Identifier for the status of the asset

​
isActive
boolean

Indicates if the asset is active

​
created_by_user_id
string

Identifier for the user who created the asset

​
locked_by_user_id
string | null

Identifier for the user who locked the asset

​
file_name
string

Name of the file associated with the asset

​
file_location
string

Location of the file associated with the asset

​
current_version_id
string

Identifier for the current version of the asset

​
sequence
integer

Sequence number of the asset

​
currentVersion
object

(Optional) Current version of the asset

​
version
object

(Optional) Version of the asset

​
versions
object[]

(Optional) List of versions of the asset

​
collaborators
object[]

(Optional) List of collaborators for the asset

User model

​
favorited

(Optional) Indicates if the asset is favorited or a list of favorite assets

​
tags
object[]

(Optional) List of tags associated with the asset

​
libraries
object[]

(Optional) List of libraries associated with the asset

​
reviewRequests
object[]

(Optional) List of review requests for the asset

Represents a request for an asset review within a workspace.

​
assetType
object

(Optional) Type of the asset

​
assetStatus
object

(Optional) Status of the asset

Was this page helpful?