/assets

The max number of assets to return in the response

Cursor to the next page of assets

The parent board ID of the assets to return

Only return assets added to this showcase. With includeNestedAssets=true, also returns the assets inside the boards added to it. Items on the showcase's sub-pages are not returned. Cannot be combined with parentBoardId or semantic=true; supplying either returns a 400. Returns 404 if the showcase does not exist and 403 if you cannot view it.

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. With a showcaseId, also returns the assets inside the boards added to the showcase. Requires parentBoardId or showcaseId to be provided.

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

When set to true, the value for search will be used to perform a semantic search using AI embeddings. search must be non-blank. It only returns one page of results ordered by relevance. The following fields will be rejected with a 400 error: tag, customField, createdAt, and cursor. This requires Semantic Search to be enabled for the workspace.

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

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).

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.