Get Assets

get

https://preview.threekit.com/api/assets

Retrieves list of assets.

Query Params

bearer_token

string

Public access token used to authorize the request. Requests may only come from the token's allowed domains. This parameter is mandatory when making requests from a browser. Outside of the browser instead supply a bearer header using a private access token.

orgId

string

required

Organization ID.

name

string

Name of an asset

publicShare

boolean

Only include assets set to be public

nameLike

string

A string which is included in the asset name

type

string

Asset type

importedFileId

string

ID of the imported file

branch

string

Name of the org branch to connect to. If no value is provided the default value is "main".

tags

string

Tags of the asset.

keywords

string

Keywords of the asset

metadata

string

Metadata of the asset. Must be passed in as a stringified JSON.

proxyId

string

Proxy ID of an asset

page

number

Page to return, defaults to 1

perPage

number

Total number of entries per page, defaults to 30 and can only go up to 100

sort

string

The direction and value to sort by, defaults to createdAt descending (denoted -createdAt)

state

string

Published status of assets. It can be 'published' or 'draft'.

archived

string

Only fetch deleted assets

includeArchived

string

Include deleted assets in the response

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful get request, response body will include the list of assets

400User did not pass orgId as query parameter.

401User is not authenticated. They must be authenticated to use this service.

403No token was provided in the query string of the request

422User pass the invalid query fields