GET - List Assets

List Assets

GET https://api.readyplayer.me/v1/assets

Use this endpoint to fetch a paginated list of assets. With query parameters, you control the order, the number of assets you want per page, and the selected page.

Query Parameters

Name	Type	Description
order	string	The properties you would like to order the list by. You can specify multiple properties by adding the query param multiple times. By default the order is ascending. If want the descending one, prepend field value with - Sortable fields: name, updatedAt,hasApps,locked Example: ?order=-name&order=locked
limit	number	The amount of documents you want to fetch per page. Default: 20 Max: 100
page	number	The page of documents you would like to fetch.
name	string	Filter to find assets by their name. Looks for partial matches.
organizationId	string	Filter to find assets by organizationId
type	string(enum)	Filter to find assets by their type. Supports multiple values. Allowed values can be found from asset properties page. Example: ?type=outfit&type=top
gender	string(enum)	Filter to find assets by their gender. Supports multiple values. Allowed values can be found from asset properties page. Example: ?gender=male &gender=neutral
ids	string	Filter to find assets by Ids. Example: ?ids=12345&ids=54321
applicationIds	string	Filter to find assets that are available in specific applications. Example: ?applicationIds=12345 &applicationIds=54321

Headers

Name	Type	Description
X-APP-ID*	string	the applicationId you are fetching the assets for.

200: OK A typical success response

"data": {
        "docs": [
            {
                "id": "63dbcb0571dad1e9aa85630c",
                "type": "outfit",
                "gender": "male",
                "iconUrl": "https://example.org/icon.png",
                "modelUrl": "https://example.org/model.glb",
                "status": "published",
                "organizationId": "61d8d13e5c7658ae34513411",
                "name": "my outfit",
                "applicationIds": [
                    "63d8e1782096e0afb2dbbe9f"
                ],
                "createdAt": "2023-02-02T14:39:01.026Z",
                "updatedAt": "2023-02-02T14:39:08.656Z",
                "publishedAt": "2023-02-02T16:39:19.216+02:00"
            }],
        "totalDocs": 18,
        "limit": 1,
        "totalPages": 18,
        "page": 1,
        "pagingCounter": 1,
        "hasPrevPage": false,
        "hasNextPage": true,
        "prevPage": 0,
        "nextPage": 2
    }
}

Example Request

Make sure not to forget the required X-APP-ID header

https://api.readyplayer.me/v1/assets?order=name&order=-updatedAt&limit=10&page=1

Example Response

Asset properties descriptions can be found at the entity properties page

{
    "data": [
        {
           "id": "145064511",
            "name": "jacket-occassionwear-02",
            "organizationId": "6453d11c462434a35b4abe17",
            "locked": false,
            "type": "top",
            "gender": "neutral",
            "modelUrl": "https://example.org/jacket-occassionwear-02.glb",
            "iconUrl": "https://example.org/jacket-occassionwear-02.png",
            "applications": [
                {
                     "id": "6479be53386e0a8665161420",
                     "organizationId": "62a58eb4df136d4df8ce0d74",
                     "isVisibleInEditor": true,
                     "masculineOrder": 1,
                     "feminineOrder": 2
                }
            ],
            "hasApps": true,
            "createdAt": "2023-02-02T14:39:01.026Z",
            "updatedAt": "2023-02-02T14:39:08.656Z"
        }
    ],
    "pagination": {
        "totalDocs": 1,
        "limit": 10,
        "totalPages": 1,
        "page": 1,
        "pagingCounter": 1,
        "hasPrevPage": false,
        "hasNextPage": false,
        "prevPage": 0,
        "nextPage": 0
    }
}