Skip to navigation

API · Assets · List or search the workspace’s assets

View as Markdown

The assets in the authenticated workspace/teamspace. Omit search to list them, newest first; pass it to narrow by asset name or tag.

search is text matching, not visual or semantic. A search term includes matching assets stored inside folders; it does not search folder names or return every asset in a named folder. asset_type narrows either form, so listing only videos needs no search term.

Results contain asset UUIDs (id), asset_name, asset_type, status, and thumbnail metadata. Use the UUIDs directly as social post media. Call getAsset for full asset details and fresh stored URLs. Follow pagination by incrementing page with the same search and filters when the response indicates another page. Do not stop after the first page when the user asks for all matching assets.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

searchstringOptional

Text to match against asset names and tags — a filename, descriptive name, or tag, not a folder name. Omit it to list every asset instead of searching.

asset_typeintegerOptional

Optional media type filter. Numeric asset type, e.g. 0=image, 2=video, 4=giphy, 6=font, 8=audio, 17=pdf.

pageintegerOptional>=1Defaults to 1

Page number; start at 1 and increment to retrieve more results.

page_sizeintegerOptional>=1

Requested number of results per page; the server applies its pagination limit.

Response

Paginated matching asset records with their UUIDs and metadata.

Errors

401
Unauthorized Error
404
Not Found Error