GET - List Assets
Last updated
Last updated
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.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Asset properties descriptions can be found at the entity properties page
Make sure not to forget the required X-APP-ID
header
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
X-APP-ID*
string
the applicationId you are fetching the assets for.