Create review request

POST

workspaces

assets

{asset_id}

reviewRequests

{user_id}

curl --request POST \
  --url https://api.mudstack.com/workspaces/assets/{asset_id}/reviewRequests/{user_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-account-id: <x-account-id>' \
  --header 'x-workspace-id: <x-workspace-id>'

{
  "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": {
    "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": [
      {}
    ],
    "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>"
    }
  },
  "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>"
  }
}

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

Path Parameters

asset_id

string

required

user_id

string

required

Query Parameters

asset_version_id

string

Response

200 - application/json

The created review request

Represents a request for an asset review within a workspace.

workspace_id

string

The ID of the workspace.

asset_id

string

The ID of the asset.

asset_version_id

string

The ID of the asset version.

requestor_id

string

The ID of the user who requested the review.

user_id

string

The ID of the user assigned to the review.

review_id

string

The ID of the review.

user

object

The user assigned to the review.

user.id

string

Unique identifier for the user

user.auth0UserID

string

Auth0 user ID

user.username

string

Username of the user

user.email

string

Email address of the user

user.firstName

string

First name of the user

user.lastName

string

Last name of the user

user.avatar_file_id

string

File ID of the user's avatar

user.defaultAvatar

number

Default avatar identifier

user.industry

string

Industry the user works in

user.occupation

string

Occupation of the user

user.company

string

Company the user works for

user.emailVerified

boolean

Whether the user's email is verified

user.isActive

boolean

Whether the user is active

user.city

string

City where the user resides

user.state

string

State where the user resides

user.country

string

Country where the user resides

user.zipCode

string

Zip code of the user's location

user.invited_by_user

object

User who invited this user

requestor

object

The user who requested the review.

requestor.id

string

Unique identifier for the user

requestor.auth0UserID

string

Auth0 user ID

requestor.username

string

Username of the user

requestor.email

string

Email address of the user

requestor.firstName

string

First name of the user

requestor.lastName

string

Last name of the user

requestor.avatar_file_id

string

File ID of the user's avatar

requestor.defaultAvatar

number

Default avatar identifier

requestor.industry

string

Industry the user works in

requestor.occupation

string

Occupation of the user

requestor.company

string

Company the user works for

requestor.emailVerified

boolean

Whether the user's email is verified

requestor.isActive

boolean

Whether the user is active

requestor.city

string

City where the user resides

requestor.state

string

State where the user resides

requestor.country

string

Country where the user resides

requestor.zipCode

string

Zip code of the user's location

requestor.invited_by_user

object

User who invited this user

asset

object

The asset being reviewed.

asset.id

string

Unique identifier for the asset

asset.workspace_id

string

Identifier for the workspace to which the asset belongs

asset.name

string

Name of the asset

asset.asset_type_id

string

Identifier for the type of the asset

asset.status_id

string

(Optional) Identifier for the status of the asset

asset.isActive

boolean

Indicates if the asset is active

asset.created_by_user_id

string

Identifier for the user who created the asset

asset.locked_by_user_id

string | null

Identifier for the user who locked the asset

asset.file_name

string

Name of the file associated with the asset

asset.file_location

string

Location of the file associated with the asset

asset.current_version_id

string

Identifier for the current version of the asset

asset.sequence

integer

Sequence number of the asset

asset.currentVersion

object

(Optional) Current version of the asset

asset.currentVersion.id

string

required

Unique identifier for the asset version

asset.currentVersion.asset_id

string

required

Identifier of the associated asset

asset.currentVersion.created_by_user_id

string

required

Identifier of the user who created the asset version

asset.currentVersion.thumbnail_file_id

string

required

Identifier of the thumbnail file

asset.currentVersion.name

string

required

Name of the asset version

asset.currentVersion.description

string

required

Description of the asset version

asset.currentVersion.key

string

required

Key associated with the asset version

asset.currentVersion.size

integer

required

Size of the asset version

asset.currentVersion.version_number

integer

required

Version number of the asset

asset.currentVersion.sequence

integer

required

Sequence number of the asset version

asset.currentVersion.checksum

string

required

Checksum of the asset version

asset.currentVersion.commit_parent_id

string

Identifier of the parent commit, if any

asset.currentVersion.user

object

User who created the asset version

asset.currentVersion.user.id

string

Unique identifier for the user

asset.currentVersion.user.auth0UserID

string

Auth0 user ID

asset.currentVersion.user.username

string

Username of the user

asset.currentVersion.user.email

string

Email address of the user

asset.currentVersion.user.firstName

string

First name of the user

asset.currentVersion.user.lastName

string

Last name of the user

asset.currentVersion.user.avatar_file_id

string

File ID of the user's avatar

asset.currentVersion.user.defaultAvatar

number

Default avatar identifier

asset.currentVersion.user.industry

string

Industry the user works in

asset.currentVersion.user.occupation

string

Occupation of the user

asset.currentVersion.user.company

string

Company the user works for

asset.currentVersion.user.emailVerified

boolean

Whether the user's email is verified

asset.currentVersion.user.isActive

boolean

Whether the user is active

asset.currentVersion.user.city

string

City where the user resides

asset.currentVersion.user.state

string

State where the user resides

asset.currentVersion.user.country

string

Country where the user resides

asset.currentVersion.user.zipCode

string

Zip code of the user's location

asset.currentVersion.user.invited_by_user

object

User who invited this user

asset.version

object

(Optional) Version of the asset

asset.version.id

string

required

Unique identifier for the asset version

asset.version.asset_id

string

required

Identifier of the associated asset

asset.version.created_by_user_id

string

required

Identifier of the user who created the asset version

asset.version.thumbnail_file_id

string

required

Identifier of the thumbnail file

asset.version.name

string

required

Name of the asset version

asset.version.description

string

required

Description of the asset version

asset.version.key

string

required

Key associated with the asset version

asset.version.size

integer

required

Size of the asset version

asset.version.version_number

integer

required

Version number of the asset

asset.version.sequence

integer

required

Sequence number of the asset version

asset.version.checksum

string

required

Checksum of the asset version

asset.version.commit_parent_id

string

Identifier of the parent commit, if any

asset.version.user

object

User who created the asset version

asset.version.user.id

string

Unique identifier for the user

asset.version.user.auth0UserID

string

Auth0 user ID

asset.version.user.username

string

Username of the user

asset.version.user.email

string

Email address of the user

asset.version.user.firstName

string

First name of the user

asset.version.user.lastName

string

Last name of the user

asset.version.user.avatar_file_id

string

File ID of the user's avatar

asset.version.user.defaultAvatar

number

Default avatar identifier

asset.version.user.industry

string

Industry the user works in

asset.version.user.occupation

string

Occupation of the user

asset.version.user.company

string

Company the user works for

asset.version.user.emailVerified

boolean

Whether the user's email is verified

asset.version.user.isActive

boolean

Whether the user is active

asset.version.user.city

string

City where the user resides

asset.version.user.state

string

State where the user resides

asset.version.user.country

string

Country where the user resides

asset.version.user.zipCode

string

Zip code of the user's location

asset.version.user.invited_by_user

object

User who invited this user

asset.versions

object[]

(Optional) List of versions of the asset

asset.versions.id

string

required

Unique identifier for the asset version

asset.versions.asset_id

string

required

Identifier of the associated asset

asset.versions.created_by_user_id

string

required

Identifier of the user who created the asset version

asset.versions.thumbnail_file_id

string

required

Identifier of the thumbnail file

asset.versions.name

string

required

Name of the asset version

asset.versions.description

string

required

Description of the asset version

asset.versions.key

string

required

Key associated with the asset version

asset.versions.size

integer

required

Size of the asset version

asset.versions.version_number

integer

required

Version number of the asset

asset.versions.sequence

integer

required

Sequence number of the asset version

asset.versions.checksum

string

required

Checksum of the asset version

asset.versions.commit_parent_id

string

Identifier of the parent commit, if any

asset.versions.user

object

User who created the asset version

asset.versions.user.id

string

Unique identifier for the user

asset.versions.user.auth0UserID

string

Auth0 user ID

asset.versions.user.username

string

Username of the user

asset.versions.user.email

string

Email address of the user

asset.versions.user.firstName

string

First name of the user

asset.versions.user.lastName

string

Last name of the user

asset.versions.user.avatar_file_id

string

File ID of the user's avatar

asset.versions.user.defaultAvatar

number

Default avatar identifier

asset.versions.user.industry

string

Industry the user works in

asset.versions.user.occupation

string

Occupation of the user

asset.versions.user.company

string

Company the user works for

asset.versions.user.emailVerified

boolean

Whether the user's email is verified

asset.versions.user.isActive

boolean

Whether the user is active

asset.versions.user.city

string

City where the user resides

asset.versions.user.state

string

State where the user resides

asset.versions.user.country

string

Country where the user resides

asset.versions.user.zipCode

string

Zip code of the user's location

asset.versions.user.invited_by_user

object

User who invited this user

asset.collaborators

object[]

(Optional) List of collaborators for the asset

User model

asset.collaborators.id

string

Unique identifier for the user

asset.collaborators.auth0UserID

string

Auth0 user ID

asset.collaborators.username

string

Username of the user

asset.collaborators.email

string

Email address of the user

asset.collaborators.firstName

string

First name of the user

asset.collaborators.lastName

string

Last name of the user

asset.collaborators.avatar_file_id

string

File ID of the user's avatar

asset.collaborators.defaultAvatar

number

Default avatar identifier

asset.collaborators.industry

string

Industry the user works in

asset.collaborators.occupation

string

Occupation of the user

asset.collaborators.company

string

Company the user works for

asset.collaborators.emailVerified

boolean

Whether the user's email is verified

asset.collaborators.isActive

boolean

Whether the user is active

asset.collaborators.city

string

City where the user resides

asset.collaborators.state

string

State where the user resides

asset.collaborators.country

string

Country where the user resides

asset.collaborators.zipCode

string

Zip code of the user's location

asset.collaborators.invited_by_user

object

User who invited this user

asset.favorited

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

asset.tags

object[]

(Optional) List of tags associated with the asset

asset.libraries

object[]

(Optional) List of libraries associated with the asset

asset.reviewRequests

object[]

(Optional) List of review requests for the asset

Represents a request for an asset review within a workspace.

asset.reviewRequests.workspace_id

string

The ID of the workspace.

asset.reviewRequests.asset_id

string

The ID of the asset.

asset.reviewRequests.asset_version_id

string

The ID of the asset version.

asset.reviewRequests.requestor_id

string

The ID of the user who requested the review.

asset.reviewRequests.user_id

string

The ID of the user assigned to the review.

asset.reviewRequests.review_id

string

The ID of the review.

asset.reviewRequests.user

object

The user assigned to the review.

asset.reviewRequests.user.id

string

Unique identifier for the user

asset.reviewRequests.user.auth0UserID

string

Auth0 user ID

asset.reviewRequests.user.username

string

Username of the user

asset.reviewRequests.user.email

string

Email address of the user

asset.reviewRequests.user.firstName

string

First name of the user

asset.reviewRequests.user.lastName

string

Last name of the user

asset.reviewRequests.user.avatar_file_id

string

File ID of the user's avatar

asset.reviewRequests.user.defaultAvatar

number

Default avatar identifier

asset.reviewRequests.user.industry

string

Industry the user works in

asset.reviewRequests.user.occupation

string

Occupation of the user

asset.reviewRequests.user.company

string

Company the user works for

asset.reviewRequests.user.emailVerified

boolean

Whether the user's email is verified

asset.reviewRequests.user.isActive

boolean

Whether the user is active

asset.reviewRequests.user.city

string

City where the user resides

asset.reviewRequests.user.state

string

State where the user resides

asset.reviewRequests.user.country

string

Country where the user resides

asset.reviewRequests.user.zipCode

string

Zip code of the user's location

asset.reviewRequests.user.invited_by_user

object

User who invited this user

asset.reviewRequests.requestor

object

The user who requested the review.

asset.reviewRequests.requestor.id

string

Unique identifier for the user

asset.reviewRequests.requestor.auth0UserID

string

Auth0 user ID

asset.reviewRequests.requestor.username

string

Username of the user

asset.reviewRequests.requestor.email

string

Email address of the user

asset.reviewRequests.requestor.firstName

string

First name of the user

asset.reviewRequests.requestor.lastName

string

Last name of the user

asset.reviewRequests.requestor.avatar_file_id

string

File ID of the user's avatar

asset.reviewRequests.requestor.defaultAvatar

number

Default avatar identifier

asset.reviewRequests.requestor.industry

string

Industry the user works in

asset.reviewRequests.requestor.occupation

string

Occupation of the user

asset.reviewRequests.requestor.company

string

Company the user works for

asset.reviewRequests.requestor.emailVerified

boolean

Whether the user's email is verified

asset.reviewRequests.requestor.isActive

boolean

Whether the user is active

asset.reviewRequests.requestor.city

string

City where the user resides

asset.reviewRequests.requestor.state

string

State where the user resides

asset.reviewRequests.requestor.country

string

Country where the user resides

asset.reviewRequests.requestor.zipCode

string

Zip code of the user's location

asset.reviewRequests.requestor.invited_by_user

object

User who invited this user

asset.reviewRequests.asset

object

The asset being reviewed.

asset.reviewRequests.asset.id

string

Unique identifier for the asset

asset.reviewRequests.asset.workspace_id

string

Identifier for the workspace to which the asset belongs

asset.reviewRequests.asset.name

string

Name of the asset

asset.reviewRequests.asset.asset_type_id

string

Identifier for the type of the asset

asset.reviewRequests.asset.status_id

string

(Optional) Identifier for the status of the asset

asset.reviewRequests.asset.isActive

boolean

Indicates if the asset is active

asset.reviewRequests.asset.created_by_user_id

string

Identifier for the user who created the asset

asset.reviewRequests.asset.locked_by_user_id

string | null

Identifier for the user who locked the asset

asset.reviewRequests.asset.file_name

string

Name of the file associated with the asset

asset.reviewRequests.asset.file_location

string

Location of the file associated with the asset

asset.reviewRequests.asset.current_version_id

string

Identifier for the current version of the asset

asset.reviewRequests.asset.sequence

integer

Sequence number of the asset

asset.reviewRequests.asset.currentVersion

object

(Optional) Current version of the asset

asset.reviewRequests.asset.version

object

(Optional) Version of the asset

asset.reviewRequests.asset.versions

object[]

(Optional) List of versions of the asset

asset.reviewRequests.asset.collaborators

object[]

(Optional) List of collaborators for the asset

User model

asset.reviewRequests.asset.favorited

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

asset.reviewRequests.asset.tags

object[]

(Optional) List of tags associated with the asset

asset.reviewRequests.asset.libraries

object[]

(Optional) List of libraries associated with the asset

asset.reviewRequests.asset.reviewRequests

object[]

(Optional) List of review requests for the asset

Represents a request for an asset review within a workspace.

asset.reviewRequests.asset.assetType

object

(Optional) Type of the asset

asset.reviewRequests.asset.assetStatus

object

(Optional) Status of the asset

asset.reviewRequests.version

object

The version of the asset being reviewed.

asset.reviewRequests.version.id

string

required

Unique identifier for the asset version

asset.reviewRequests.version.asset_id

string

required

Identifier of the associated asset

asset.reviewRequests.version.created_by_user_id

string

required

Identifier of the user who created the asset version

asset.reviewRequests.version.thumbnail_file_id

string

required

Identifier of the thumbnail file

asset.reviewRequests.version.name

string

required

Name of the asset version

asset.reviewRequests.version.description

string

required

Description of the asset version

asset.reviewRequests.version.key

string

required

Key associated with the asset version

asset.reviewRequests.version.size

integer

required

Size of the asset version

asset.reviewRequests.version.version_number

integer

required

Version number of the asset

asset.reviewRequests.version.sequence

integer

required

Sequence number of the asset version

asset.reviewRequests.version.checksum

string

required

Checksum of the asset version

asset.reviewRequests.version.commit_parent_id

string

Identifier of the parent commit, if any

asset.reviewRequests.version.user

object

User who created the asset version

asset.reviewRequests.review

object

The review details.

asset.reviewRequests.review.id

string

Unique identifier for the asset review.

asset.reviewRequests.review.asset_id

string

Unique identifier for the asset being reviewed.

asset.reviewRequests.review.asset_version_id

string | null

Unique identifier for the version of the asset being reviewed.

asset.reviewRequests.review.user_id

string

Unique identifier for the user who created the review.

asset.reviewRequests.review.assigned_user_id

string | null

Unique identifier for the user assigned to the review.

asset.reviewRequests.review.status

enum<string>

Status of the review.

Available options:

approved,

rejected

asset.reviewRequests.review.content

string

Content of the review.

asset.reviewRequests.review.mentions

string[]

List of user mentions in the review.

asset.reviewRequests.review.viewer_metadata

object

Metadata for the viewer.

asset.reviewRequests.review.attachments

object[]

List of attachments associated with the review.

Represents an attachment associated with an asset.

asset.reviewRequests.review.version

object

Version of the asset being reviewed.

asset.reviewRequests.review.user

object

User who created the review.

asset.reviewRequests.review.assignee

object

User assigned to the review.

asset.reviewRequests.review.workspace_id

string | null

Unique identifier for the workspace.

asset.assetType

object

(Optional) Type of the asset

asset.assetStatus

object

(Optional) Status of the asset

version

object

The version of the asset being reviewed.

version.id

string

required

Unique identifier for the asset version

version.asset_id

string

required

Identifier of the associated asset

version.created_by_user_id

string

required

Identifier of the user who created the asset version

version.thumbnail_file_id

string

required

Identifier of the thumbnail file

version.name

string

required

Name of the asset version

version.description

string

required

Description of the asset version

version.key

string

required

Key associated with the asset version

version.size

integer

required

Size of the asset version

version.version_number

integer

required

Version number of the asset

version.sequence

integer

required

Sequence number of the asset version

version.checksum

string

required

Checksum of the asset version

version.commit_parent_id

string

Identifier of the parent commit, if any

version.user

object

User who created the asset version

version.user.id

string

Unique identifier for the user

version.user.auth0UserID

string

Auth0 user ID

version.user.username

string

Username of the user

version.user.email

string

Email address of the user

version.user.firstName

string

First name of the user

version.user.lastName

string

Last name of the user

version.user.avatar_file_id

string

File ID of the user's avatar

version.user.defaultAvatar

number

Default avatar identifier

version.user.industry

string

Industry the user works in

version.user.occupation

string

Occupation of the user

version.user.company

string

Company the user works for

version.user.emailVerified

boolean

Whether the user's email is verified

version.user.isActive

boolean

Whether the user is active

version.user.city

string

City where the user resides

version.user.state

string

State where the user resides

version.user.country

string

Country where the user resides

version.user.zipCode

string

Zip code of the user's location

version.user.invited_by_user

object

User who invited this user

review

object

The review details.

review.id

string

Unique identifier for the asset review.

review.asset_id

string

Unique identifier for the asset being reviewed.

review.asset_version_id

string | null

Unique identifier for the version of the asset being reviewed.

review.user_id

string

Unique identifier for the user who created the review.

review.assigned_user_id

string | null

Unique identifier for the user assigned to the review.

review.status

enum<string>

Status of the review.

Available options:

approved,

rejected

review.content

string

Content of the review.

review.mentions

string[]

List of user mentions in the review.

review.viewer_metadata

object

Metadata for the viewer.

review.attachments

object[]

List of attachments associated with the review.

Represents an attachment associated with an asset.

review.attachments.id

string

Unique identifier for the asset attachment.

review.attachments.asset_id

string

Identifier of the associated asset.

review.attachments.created_by_user_id

string

Identifier of the user who created the attachment.

review.attachments.file_id

string

Identifier of the file associated with the attachment.

review.attachments.thumbnail_file_id

string

Identifier of the thumbnail file associated with the attachment.

review.attachments.review_id

string

Identifier of the associated review.

review.attachments.comment_id

string

Identifier of the associated comment.

review.attachments.name

string

Name of the attachment.

review.attachments.description

string

Description of the attachment.

review.attachments.user

object

User associated with the attachment.

review.attachments.user.id

string

Unique identifier for the user

review.attachments.user.auth0UserID

string

Auth0 user ID

review.attachments.user.username

string

Username of the user

review.attachments.user.email

string

Email address of the user

review.attachments.user.firstName

string

First name of the user

review.attachments.user.lastName

string

Last name of the user

review.attachments.user.avatar_file_id

string

File ID of the user's avatar

review.attachments.user.defaultAvatar

number

Default avatar identifier

review.attachments.user.industry

string

Industry the user works in

review.attachments.user.occupation

string

Occupation of the user

review.attachments.user.company

string

Company the user works for

review.attachments.user.emailVerified

boolean

Whether the user's email is verified

review.attachments.user.isActive

boolean

Whether the user is active

review.attachments.user.city

string

City where the user resides

review.attachments.user.state

string

State where the user resides

review.attachments.user.country

string

Country where the user resides

review.attachments.user.zipCode

string

Zip code of the user's location

review.attachments.user.invited_by_user

object

User who invited this user

review.version

object

Version of the asset being reviewed.

review.version.id

string

required

Unique identifier for the asset version

review.version.asset_id

string

required

Identifier of the associated asset

review.version.created_by_user_id

string

required

Identifier of the user who created the asset version

review.version.thumbnail_file_id

string

required

Identifier of the thumbnail file

review.version.name

string

required

Name of the asset version

review.version.description

string

required

Description of the asset version

review.version.key

string

required

Key associated with the asset version

review.version.size

integer

required

Size of the asset version

review.version.version_number

integer

required

Version number of the asset

review.version.sequence

integer

required

Sequence number of the asset version

review.version.checksum

string

required

Checksum of the asset version

review.version.commit_parent_id

string

Identifier of the parent commit, if any

review.version.user

object

User who created the asset version

review.version.user.id

string

Unique identifier for the user

review.version.user.auth0UserID

string

Auth0 user ID

review.version.user.username

string

Username of the user

review.version.user.email

string

Email address of the user

review.version.user.firstName

string

First name of the user

review.version.user.lastName

string

Last name of the user

review.version.user.avatar_file_id

string

File ID of the user's avatar

review.version.user.defaultAvatar

number

Default avatar identifier

review.version.user.industry

string

Industry the user works in

review.version.user.occupation

string

Occupation of the user

review.version.user.company

string

Company the user works for

review.version.user.emailVerified

boolean

Whether the user's email is verified

review.version.user.isActive

boolean

Whether the user is active

review.version.user.city

string

City where the user resides

review.version.user.state

string

State where the user resides

review.version.user.country

string

Country where the user resides

review.version.user.zipCode

string

Zip code of the user's location

review.version.user.invited_by_user

object

User who invited this user

review.user

object

User who created the review.

review.user.id

string

Unique identifier for the user

review.user.auth0UserID

string

Auth0 user ID

review.user.username

string

Username of the user

review.user.email

string

Email address of the user

review.user.firstName

string

First name of the user

review.user.lastName

string

Last name of the user

review.user.avatar_file_id

string

File ID of the user's avatar

review.user.defaultAvatar

number

Default avatar identifier

review.user.industry

string

Industry the user works in

review.user.occupation

string

Occupation of the user

review.user.company

string

Company the user works for

review.user.emailVerified

boolean

Whether the user's email is verified

review.user.isActive

boolean

Whether the user is active

review.user.city

string

City where the user resides

review.user.state

string

State where the user resides

review.user.country

string

Country where the user resides

review.user.zipCode

string

Zip code of the user's location

review.user.invited_by_user

object

User who invited this user

review.assignee

object

User assigned to the review.

review.assignee.id

string

Unique identifier for the user

review.assignee.auth0UserID

string

Auth0 user ID

review.assignee.username

string

Username of the user

review.assignee.email

string

Email address of the user

review.assignee.firstName

string

First name of the user

review.assignee.lastName

string

Last name of the user

review.assignee.avatar_file_id

string

File ID of the user's avatar

review.assignee.defaultAvatar

number

Default avatar identifier

review.assignee.industry

string

Industry the user works in

review.assignee.occupation

string

Occupation of the user

review.assignee.company

string

Company the user works for

review.assignee.emailVerified

boolean

Whether the user's email is verified

review.assignee.isActive

boolean

Whether the user is active

review.assignee.city

string

City where the user resides

review.assignee.state

string

State where the user resides

review.assignee.country

string

Country where the user resides

review.assignee.zipCode

string

Zip code of the user's location

review.assignee.invited_by_user

object

User who invited this user

review.workspace_id

string | null

Unique identifier for the workspace.

Was this page helpful?

Delete review Get review requests

curl --request POST \
  --url https://api.mudstack.com/workspaces/assets/{asset_id}/reviewRequests/{user_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-account-id: <x-account-id>' \
  --header 'x-workspace-id: <x-workspace-id>'

{
  "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": {
    "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": [
      {}
    ],
    "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>"
    }
  },
  "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>"
  }
}

Core Concepts

Examples

Endpoints

Authorizations

Headers

Path Parameters

Query Parameters

Response