Sign inGet Started

List workspace media-library folders

GET
/v1/asset-folders
for await (const folder of bird.assets.folders.list()) {
  console.log(folder.id, folder.path);
}
Reactie200
{
  "data": [
    {
      "created_at": "2026-05-20T09:14:52Z",
      "updated_at": "2026-05-25T16:42:01Z",
      "id": "asf_01krdgeqcxet5s7t44vh8rt9mg",
      "parent_id": "asf_01krdgeqcxet5s7t44vh8rt9mg"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns the workspace's media-library folders as a flat list, each carrying its parent_id and its resolved path, most recently created first.

Assemble the tree from parent_id. The ordering is by creation time rather than by position in the tree, so a page can contain a folder whose parent has not arrived yet. Page through to the end before treating a missing parent as an orphan. A workspace supports up to 1,000 active folders and 10,000 retained folders, including deleted folders. Deletion frees an active slot but does not release retained capacity.

Queryparameters

sortstring

Field to sort by. Defaults to created_at.

Possible values: created_at

orderstring

Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.

Possible values: asc, desc

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor 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_totalboolean

When true, the response includes a total field with the total number of items matching the request's filters across all pages.

Response Payload

data
array of object
verplicht
Onderliggende attributen tonen
data.created_at
string
verplicht
data.updated_at
string
verplicht
data.id
string
verplicht
data.name
string
verplicht

The folder's display name. Unique among folders sharing the same parent, compared without regard to case.

data.parent_id
nullable string
verplicht

The folder this one sits in, or null when it sits at the top level of the library.

data.path
string
verplicht

The folder's location written out from the top level, such as /Marketing/Logos. Provided so a caller can display a folder without walking its parents.

next_cursor
nullable string
verplicht

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor
nullable string
verplicht

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor
nullable string
verplicht

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

total
nullable integer

Total number of items matching the request's filters across all pages. Present only when include_total=true was passed; otherwise null.

Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.