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. Please check the example-response to check the names. By default the order is ascending. If want the descending one, add the `-` to the field name Allowed values: name, -name udpatedAt, -updatedAt hasApps, -hasApps
limit	number	The amount of documents you want to fetch per page.
page	number	The page of documents you would like to fetch.

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

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

Example Response

{
    "data": [
        {
            "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"
        }
    ],
    "pagination": {
        "totalDocs": 1,
        "limit": 10,
        "totalPages": 1,
        "page": 1,
        "pagingCounter": 1,
        "hasPrevPage": false,
        "hasNextPage": false,
        "prevPage": 0,
        "nextPage": 0
    }
}