List image assets

Search Documentation

Search across all developer documentation

assets

List image assets

GET /v1/assets
Auth required api.assets.view

Returns the org's image asset library, ordered by source path — the images uploaded through this API. url is the public CDN URL, or empty until an Edge stack is provisioned.

Query parameters

limit integer optional

Page size (1–200). Default 50.

cursor string optional

Opaque cursor returned from the previous page.

tag array optional

Filter to entities carrying a tag with this full path name (repeatable; union/OR across values — the Gmail default). Pass untagged=true instead to return only entities with no tags. Applied before pagination.

Responses

Errors follow the RFC 7807 problem format — see the error reference.

200 Cursor-paginated list of image assets application/json
data array<object> required

Each entry in data:

id string<uuid> required
source_path string required

The logical path templates reference, e.g. static/logo.png. It is the path that was supplied on upload.

url string required

Public CDN URL for the image, or "" when no Edge stack is provisioned yet.

content_hash string required

Content-addressed hash of the image bytes.

content_type string required

MIME type, e.g. image/png.

size_bytes integer<int64> required
width integer required

Pixel width, or 0 when unknown (e.g. SVG).

height integer required

Pixel height, or 0 when unknown (e.g. SVG).

created_at string<date-time> required
referenced_by array<object> required

The templates whose body references this asset's path. Always present: an empty array means the scan ran and found none, which is what a caller about to delete the asset needs to know.

Each entry in referenced_by:

id string<uuid> required
name string required
tags array<object> optional

Org-side tags/folders applied to this asset (managed via the dashboard). Filter the collection with ?tag=.

Each entry in tags:

id string<uuid> required
name string required

Full folder path (e.g. Marketing/Newsletters).

key string required

Normalized slug handle of the name.

color string optional

Chip colour token (chart-1..chart-5), or empty.

description string optional
created_at string<date-time> required
updated_at string<date-time> required
pagination object required

Fields of pagination:

has_more boolean required
next_cursor string | null optional
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
422 A query parameter, path value or body field failed validation. The body is a validation_failed Problem. When the refusal is about a reference — a segment key, template slug, topic or attribute name the organization does not have — it additionally carries validation_code, field, line/column, missing, candidates and next_step, so a client can correct the call without a second round of guessing. See ValidationProblem. application/problem+json
429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json