Sign in
latestOpenAPI 3.0.32026-07-13142734.3 KB

34213152576e

application

List Application Assets

get/applications/{appId}/assets

Path parameters

appIdstring required

The id of the application

Query parameters

namestring

Filter to find assets by their name. Looks for partial matches

organizationIdstring

Filter to find assets by organizationId

typeAssetType[]

Filter to find assets by their type. Supports multiple values

genderAssetGender[]

Filter to find assets by their gender. Supports multiple values

idsstring[]

Filter to find assets by Ids

applicationIdsstring[]

Filter to find assets that are available in specific applications

Parameters

#/components/parameters/sortBy — unresolved $ref
#/components/parameters/sortDir — unresolved $ref
#/components/parameters/pageNumber — unresolved $ref
#/components/parameters/pageSize — unresolved $ref

Response

A typical success response

idstring

Automatically generated numeric Identifier of an asset

namestring

The name of an asset

organizationIdstring

The Id of the asset owner organization

lockedboolean

A boolean value which when set to true requires the asset to be unlocked for specific user before it is usable by them

type'outfit' | 'top' | 'shirt' | 'bottom' | 'beard' | 'eye' | 'eyebrows' | 'eyeshape' | 'facemask' | 'faceshape' | 'facewear' | 'footwear' | 'glasses' | 'hair' | 'headwear' | 'lipshape' | 'noseshape' | 'costume'

Defines which body part of the avatar this asset belongs to

gender'male' | 'female' | 'neutral'

Defines which avatar genders are supported

modelUrlstring

The URL where you can find the GLB model for the asset

iconUrlstring

The URL where you can find the icon for the asset

hasAppsboolean

A boolean value indicating if this asset is available in any applications or not

createdAtstring date-time

Datetime when this asset was created

updatedAtstring date-time

Datetime when this asset was last updated

Example response

[
  {
    "id": "145064511",
    "name": "jacket-occassionwear-02",
    "organizationId": "6453d11c462434a35b4abe17",
    "modelUrl": "https://example.org/jacket-occassionwear-02.glb",
    "iconUrl": "https://example.org/jacket-occassionwear-02.png",
    "hasApps": true,
    "createdAt": "2023-02-02T14:39:01.026Z",
    "updatedAt": "2023-02-02T14:39:08.656Z",
    "applications": [
      {
        "id": "6479be53386e0a8665161420",
        "organizationId": "6453d11c462434a35b4abe17",
        "isVisibleInEditor": true,
        "masculineOrder": 1,
        "feminineOrder": 2
      }
    ]
  }
]