Sign inGet Started

bird assets list

Usage

Code example
bird assets list [flags]

Description

Returns a cursor page, excluding deleted assets by default. Filters support kind, content type, name and folder. A folder filter excludes its subfolders; root_only selects unfiled assets.

Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Code example
bird assets list
bird assets list | jq -r '.data[].id'
bird assets list --limit 50 --starting-after <cursor>

Options

Filters

NameDescription
--content-typeReturn only assets stored with this media type. Possible values: image/png, image/jpeg, image/gif, video/mp4, video/webm, video/quicktime, audio/mpeg, audio/mp4, audio/ogg, audio/wav, application/pdf.
--deletedWhether to include assets that have been removed from the library. Removed assets keep serving at their original URL, so they remain listable. Possible values: exclude, include, only.
--folder-idReturn only the assets filed directly in this folder. Subfolders are not included, and a folder that does not exist matches nothing. Cannot be combined with root_only.
--kindReturn only assets in this category. This groups exact content_type values into images, video, audio, and documents. Possible values: image, video, audio, document.
--qA case-insensitive substring match against the asset's name.
--response-schemaPrint the fields this command returns, then exit
--root-onlyReturn only the assets at the top level of the library, filed in no folder. Cannot be combined with folder_id.

Pagination

NameDescription
--ending-beforeCursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
--include-totalWhen true, the response includes a total field with the total number of items matching the request's filters across all pages.
--limit <n>Maximum number of items to return per page. Allowed range: 1 to 100.
--orderSort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field. Possible values: asc, desc.
--sortField to sort by. Defaults to created_at. Possible values: created_at.
--starting-afterCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
NameDescription
bird assets deleteRemove an asset from the media library
bird assets getGet a media-library asset by ID
bird assets updateUpdate asset metadata or folder placement
bird assets uploadCreate a media-library asset

Continue with the documentation, guides and examples for this topic.