Get all assets of a schema

GET 
/assets/by/schema/:schemaId

Get all assets of a schema

Request

Path Parameters

schemaId schemaIdrequired

The schemaId to grab data about

Query Parameters

type assetType

The type of the assets to grab

matchTags boolean

Whether to get the assets that match the schema tags (coming from project and global assets)

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 projects 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 Schema

application/json

Schema

Schema

• Array [

id string

Unique identifier for Asset

type string
createdAt date-time

Time representation of Asset creation

url string

Asset URL

schemaId schemaId (string)

Unique identifier for Schema

description string

Asset description

tags string[]

Asset tags

data string

Asset data

projectId projectId (string)

Unique identifier for Project

name stringrequired

Asset name

• ]

Example (from schema)

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

Example

[
  {
    "id": "a14oCJX30",
    "type": "vehicle",
    "url": "https://example.com/assets/cyberpunk-motorcycle.fbx",
    "createdAt": "2024-01-07T15:00:00.00Z",
    "schemaId": "s11EFBu2XW",
    "description": "A sleek 3D model of a cyberpunk motorcycle, perfect for high-speed chases",
    "tags": [
      "3D model",
      "motorcycle",
      "cyberpunk",
      "vehicle"
    ],
    "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]],\"base",
    "projectId": "null",
    "name": "Cyberpunk Motorcycle"
  },
  {
    "type": "building",
    "id": "a1guhMEji",
    "description": "A detailed 3D model of a futuristic cyberpunk cityscape",
    "createdAt": "2024-01-08T16:30:00.00Z",
    "url": "https://example.com/assets/cyberpunk-cityscape.fbx",
    "schemaId": "s11EFBu2XW",
    "projectId": "null",
    "name": "Cyberpunk Cityscape",
    "tags": [
      "3D model",
      "city",
      "cyberpunk",
      "environment"
    ],
    "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]],\"vector"
  }
]

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...