Skip to main content

Function: listAssets()

listAssets(client, props): Promise<{ rows: object[]; rowCount: number; }>

Lists assets with optional filtering and pagination.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

query​

{ pageOffset?: number; pageSize?: number; sortBy?: "name" | "likeCount" | "shareCount" | "createdAt" | "updatedAt"; sortDir?: "asc" | "desc"; visibility?: "PRIVATE" | "PUBLIC" | "UNLISTED"; searchText?: string; type?: "MODEL" | "MATERIAL" | "IMAGE" | "SCENE" | "ENVMAP" | "CAD" | "LIGHT"; userName?: string; orgName?: string; projectName?: string; archived?: boolean; } = listAssetsQuerySchema

Query parameters for filtering, pagination, and sorting

query.pageOffset?​

number = ...

query.pageSize?​

number = ...

query.sortBy?​

"name" | "likeCount" | "shareCount" | "createdAt" | "updatedAt" = ...

query.sortDir?​

"asc" | "desc" = ...

query.visibility?​

"PRIVATE" | "PUBLIC" | "UNLISTED" = ...

query.searchText?​

string = ...

query.type?​

"MODEL" | "MATERIAL" | "IMAGE" | "SCENE" | "ENVMAP" | "CAD" | "LIGHT" = ...

query.userName?​

string = ...

query.orgName?​

string = ...

query.projectName?​

string = ...

query.archived?​

boolean = ...

Returns​

Promise<{ rows: object[]; rowCount: number; }>

Promise resolving to a paginated list of assets

Operation Id​

list-assets-in-project

Example​

const assets = await listAssets(client, {
  query: { visibility: 'PUBLIC', pageOffset: 0, pageSize: 20 }
});