GET
/
workspaces
/
assets
/
search
cURL
curl --request GET \
  --url https://api.mudstack.com/workspaces/assets/search \
  --header 'Authorization: Bearer <token>' \
  --header 'x-account-id: <x-account-id>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "assets": [
    {
      "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<uuid>
required
​
x-workspace-id
string<uuid>
required

Query Parameters

​
query
string
​
groupBy
string
​
filter
object

A collection of filters applied to a search.

Example:
{
  "assetType": ["image", "video"],
  "tags": ["tag1", "tag2"],
  "libraries": ["library1", "library2"],
  "assetStatus": ["status1", "status2"],
  "favorites": ["true"],
  "collaborators": ["user1", "user2"],
  "reviewStatus": ["approved", "rejected"],
  "locked": ["true", "false"]
}
​
archived
boolean
​
sort
object
​
folder
string
​
pagination
object
​
library_id
string

Response

200 - application/json

Search results

​
assets
object[]