Get all assets of a project

GET 
/assets/by/project/:projectId

Get all assets of a project

Request

Path Parameters

projectId projectIdrequired

The projectId to grab data about

Query Parameters

tags string[]

The tags of the assets to grab

type assetType

The type of the assets to grab

startDate date-time

Search by start date

endDate date-time

Search by end date

page integer

Possible values: >= 1

Default value: 1

Specify the page number for pagination (default is 1).

limit integer

Default value: 10

Specify the number of assets per page (default is 10, 0 gets all results).

orderBy string

Possible values: [createdAt, type, name, state]

Field to order the results by (e.g., 'createdAt', 'ownerId'). Default is 'createdAt'.

sortOrder string

Possible values: [asc, desc]

Default value: desc

'asc' for ascending or 'desc' for descending order. Default is 'desc'.

Responses

200

List of assets for a projectId

application/json

Schema

Schema

• Array [

name assetName (string)required

Possible values: <= 32 characters

Name of the asset

tags string[]

Asset tags

url string

Asset URL

createdAt date-time

Time representation of Asset creation

schemaId schemaId (string)

Unique identifier for Schema

type string
data string

Asset data

description string

Asset description

id string

Unique identifier for Asset

projectId projectId (string)

Unique identifier for Project

• ]

Example (from schema)

[
  {
    "name": "Profile picture",
    "tags": [
      "adobeillustrator",
      "border",
      "imageborder"
    ],
    "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "createdAt": "2024-01-01T09:00:00.00Z",
    "schemaId": "s2S7KuFGc",
    "type": "tutorial",
    "data": "{\"type\":\"youtube\",\"youtubeId\":\"e6pbkJ37U\"}",
    "description": "In today's video, I'll be showing you...",
    "id": "a7qDzJ7XD",
    "projectId": "p2Duhf5N6"
  }
]

Example

[
  {
    "url": "https://example.com/assets/medieval-sword.fbx",
    "createdAt": "2024-01-02T10:00:00.00Z",
    "schemaId": "null",
    "tags": [
      "3D model",
      "sword",
      "medieval",
      "fantasy"
    ],
    "name": "Medieval Sword",
    "type": "gameAsset",
    "description": "A high-quality 3D model of a medieval sword, perfect for fantasy RPGs.",
    "id": "apitCBWUR",
    "data": "{\"mesh\":{\"vertices\":[[-1.0,1.0,0.0],[1.0,1.0,0.0],[1.0,-1.0,0.0],[-1.0,-1.0,0.0]],\"faces..",
    "projectId": "p2Duhf5N6"
  },
  {
    "data": "{\"mesh\":{\"vertices\":[[-1.0,1.0,0.0],[1.0,1.0,0.0],[1.0,-1.0,0.0],[-1.0,-1.0,0.0]],\"faces..",
    "id": "a18xjUYAN",
    "description": "A realistic 3D model of a medieval castle, suitable for strategy games.",
    "projectId": "p2Duhf5N6",
    "name": "Medieval Castle",
    "tags": [
      "3D model",
      "castle",
      "medieval",
      "strategy"
    ],
    "schemaId": "null",
    "createdAt": "2024-01-04T12:00:00.00Z",
    "url": "https://example.com/assets/medieval-castle.fbx",
    "type": "gameAsset"
  }
]

404

NotFound

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "A mandatory item was not found"
}

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "An unexpected error occured"
}

Loading...