v1

latestOpenAPI 3.0.02026-07-2452762.3 KB
Assets

/assets

Get a list of assets.

Sorted by coverVersion.updatedAt descending (most recently updated asset version first).

get/v1/assets

Query parameters

limitstring

The max number of assets to return in the response

cursorstring

Cursor to the next page of assets

parentBoardIdstring

The parent board ID of the assets to return

includeNestedAssetsboolean

When set to true along with a parentBoardId, returns assets from all nested sub-boards rather than only the immediate children of the specified board. Requires parentBoardId to be provided.

searchstring

Search for assets with metadata matching the provided value including the title, description, etc.

tagstring

Filter assets by attached tags. If multiple tag=value pairs are provided, only assets with all specified tags will be included.

customFieldstring

For single- and multi-select custom fields, filter for entities matching specific values. This query parameter can be supplied multiple times, as custom field ID UUID and custom field value ID UUID pairs, separated by a colon :, e.g. &customField=fb9e852c-eb2a-4dd0-81f4-7af266c335d1:7b6e39bb-28bb-46ae-be8a-5c01bbacf78c. Supplying multiple custom field UUID's matches all (AND), and mutliple custom field value UUID's per the same repeated custom field matches any (OR).

gtestring date-time

Filter assets created on or after this date

ltestring date-time

Filter assets created on or before this date

Filter assets by creation date. Provide an object with optional gte (greater than or equal) and lte (less than or equal) properties as ISO 8601 date strings, e.g. createdAt[gte]=2024-01-01T00:00:00.000Z&createdAt[lte]=2024-12-31T23:59:59.999Z.

Response

Filter by tag

totalinteger
All 52 operations