---
title: "List workspace media-library assets"
method: GET
path: "/v1/assets"
tags: ["assets"]
---

# List workspace media-library assets

`GET /v1/assets`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/assets`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

Returns a cursor page of the workspace's media-library assets, most recently created first. Filters can narrow results by media type, name, deletion status, or folder placement.

## Query parameters

- `sort` 'created_at': Field used to order media-library records.
- `kind` 'image' | 'video' | 'audio' | 'document': The media category to select when listing assets. - `image`: covers PNG, JPEG, and GIF. - `video`: covers MP4, WebM, and QuickTime. - `audio`: covers MP3, M4A, Ogg, and WAV. - `document`: covers PDF.
- `content_type` 'image/png' | 'image/jpeg' | 'image/gif' | 'video/mp4' | 'video/webm' | 'video/quicktime' | 'audio/mpeg' | 'audio/mp4' | 'audio/ogg' | 'audio/wav' | 'application/pdf': Stored media type to match.
- `deleted` 'exclude' | 'include' | 'only': Whether to include assets removed from the library.
- `q` string
- `folder_id` string
- `root_only` boolean
- `order` 'asc' | 'desc': Sort direction, ascending or descending.
- `limit` integer
- `starting_after` string
- `ending_before` string
- `include_total` boolean

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

A page of assets.

- AssetList
  - `data` Asset[], required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `id` string, required
    - `url` string, uri, required: The asset's permanent public URL. Safe to embed or link in sent messages; for a document the usable form is a link.
    - `thumbnail_url` string, uri, nullable, required: A small preview of the asset, for rendering a picker or a grid. Intended for your own interfaces rather than for embedding in messages. Null for every kind but `image`: generating a preview of a video, an audio file, or a document would mean rendering its contents, which the library does not do. Show an icon for the `kind` instead.
    - `name` string, required: The asset's display name. Defaults to the uploaded file's name.
    - `content_type` string, required: The stored file's media type, determined from its contents.
    - `kind` string, required: The category a media-library asset's type falls into. Use it to group or filter a mixed library. - `image`: covers PNG, JPEG, and GIF. - `video`: covers MP4, WebM, and QuickTime. - `audio`: covers MP3, M4A, Ogg, and WAV. - `document`: covers PDF.
    - `size_bytes` integer, required: The stored file's size in bytes. Images are re-encoded on upload, so for those this can differ from the size of the file you sent. Every other kind is stored byte-for-byte.
    - `width` integer, nullable, required: The stored image's width in pixels. Null for every kind but `image`.
    - `height` integer, nullable, required: The stored image's height in pixels. Null for every kind but `image`.
    - `alt_text` string, nullable, required: Default alternative text describing the asset, carried along whenever it is placed. Most mail clients block images by default, so for an image this is often the only thing a recipient reads.
    - `folder_id` string, required
    - `deleted_at` string, date-time, nullable, required: When the asset was removed from the library, or null if it is still listed. A removed asset keeps serving at its original URL.
  - `next_cursor` string, nullable, required: Cursor for the next page. Pass back as `starting_after` to advance forward. `null` when no next page exists.
  - `prev_cursor` string, nullable, required: Cursor for the previous page. Pass back as `ending_before` to step backward. `null` when no previous page exists.
  - `refresh_cursor` string, nullable, required: 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` integer, nullable: Total number of items matching the request's filters across all pages. Present only when `include_total=true` was passed; otherwise `null`.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error
- `501`: The operation is not supported

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/3e2a50466454?raw)