---
title: "List reusable email blocks"
canonical: "https://bird.com/docs/api/reference/list-email-blocks"
---

# List reusable email blocks

`GET /v1/email/blocks`

Returns the workspace's reusable email blocks without their content. Filter by part of the name with `q`, or by archive state with `archived`; leave `archived` out to return active and archived blocks together.

## Servers

- `https://{region}.platform.bird.com`: Regional API endpoint. Use the host for the region your organization is hosted in. Official Bird SDKs and the CLI select it automatically from your API key, so you rarely need to set it by hand.
  - `region`: `us1`, `eu1`. Default: `us1`. The region your organization's data is hosted in.

## Authentication

Use one authentication option:

- `BearerAuth`: HTTP bearer authentication. Pass the API key as a bearer token in the `Authorization` header. Workspace
keys use `bk_{region}_*`; organization master keys use `bm_{region}_*`.
The prefix identifies the region and selects the
API endpoint. Official Bird SDKs and the CLI derive the region from the key.

## Code samples

**TypeScript**

```ts
// Requires email_management:read permission in the target workspace.
for await (const block of bird.email.blocks.list({ q: "footer", archived: false })) {
  console.log(block.id, block.name, block.source_language);
}
```

Examples: [TypeScript](/docs/api/reference/list-email-blocks.ts.md) · [Python](/docs/api/reference/list-email-blocks.py.md) · [Go](/docs/api/reference/list-email-blocks.go.md) · [PHP](/docs/api/reference/list-email-blocks.php.md) · [CLI](/docs/api/reference/list-email-blocks.cli.md) · [MCP](/docs/api/reference/list-email-blocks.mcp.md) · [cURL](/docs/api/reference/list-email-blocks.curl.md)

## Example response `200`

```json
{
  "data": [
    {
      "id": "ebl_01krdgeqcxet5s7t44vh8rt9mg",
      "name": "Legal disclosure",
      "source_language": "pt-BR",
      "revision": 1,
      "created_by": {
        "id": "usr_01krdgeqcxet5s7t44vh8rt9mg",
        "type": "user"
      },
      "created_at": "2026-05-20T09:14:52Z",
      "updated_at": "2026-05-25T16:42:01Z"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
```

## Query parameters

- `sort` (string, optional)

  Field to sort by. Defaults to `created_at`.

  Possible values: `created_at`, `name`
- `order` (string, optional)

  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`
- `limit` (integer, optional): Maximum number of items to return per page.
- `starting_after` (string, optional): Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order.
- `ending_before` (string, optional): 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_total` (boolean, optional): When true, the response includes a `total` field with the total number of items matching the request's filters across all pages.
- `q` (string, optional): Case-insensitive text to match within the block name.
- `archived` (boolean, optional): Return only archived blocks when true, or only active blocks when false.

## Header parameters

- `X-Workspace-Id` (string, optional): Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.
- `X-Organization-Id` (string, optional): Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

## Response body

- `data` (array of object, required)
- `data.id` (string, required)
- `data.name` (string, required): Name for people choosing the block, such as when linking it into a template.
- `data.description` (string): Optional notes for people maintaining the block. Omitted when empty.
- `data.source_language` (string, required): A language tag in BCP-47 form, for example `en` or `pt-BR`.
- `data.revision` (integer, required): Metadata revision to send when editing or duplicating this block.
- `data.created_by` (object, required): Who created the block. A duplicate is created by whoever duplicated it.
- `data.created_by.id` (string, required): Actor identifier.
- `data.created_by.type` (string, required)

  New actor types may be added. Treat unrecognized values as future types, not errors.
  - `user`: a member's own session.
  - `api_key`: a workspace API key.
  - `oauth_token`: a token issued to a caller on a member's behalf.
  - `system`: an action we perform without a customer actor.
  - `sso`: an organization's SSO connection.
  - `service_account`: a workspace's connected Integration acting with no member behind it.
  - `automation`: an automation execution in your workspace.

  Possible values (may grow over time): `user`, `api_key`, `oauth_token`, `system`, `sso`, `service_account`, `automation`
- `data.created_by.display_name` (nullable string): The label the actor is shown under: typically a member's name or email address, or the API key's name. Null when it could not be resolved.
- `data.archived_at` (string): Present when the block is archived. Retained published content remains readable.
- `data.created_at` (string, required)
- `data.updated_at` (string, required)
- `next_cursor` (nullable string, required): Cursor for the next page. Pass back as `starting_after` to advance forward. `null` when no next page exists.
- `prev_cursor` (nullable string, required): Cursor for the previous page. Pass back as `ending_before` to step backward. `null` when no previous page exists.
- `refresh_cursor` (nullable string, 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` (nullable integer): Total number of items matching the request's filters across all pages. Present only when `include_total=true` was passed, and omitted otherwise.

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)
