Sign inGet Started

List reusable email blocks

GET
/v1/email/blocks
// 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);
}
Odpowiedź200
{
  "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"
}

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.

Parametry zapytania

sortstring

Field to sort by. Defaults to created_at.

Possible values: created_at, name

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.

qstring

Case-insensitive text to match within the block name.

archivedboolean

Return only archived blocks when true, or only active blocks when false.

Treść odpowiedzi

data
array of object
wymagane
Pokaż atrybuty podrzędne
data.id
string
wymagane
data.name
string
wymagane

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
wymagane

A language tag in BCP-47 form, for example en or pt-BR.

data.revision
integer
wymagane

Metadata revision to send when editing or duplicating this block.

data.created_by
object
wymagane

Who created the block. A duplicate is created by whoever duplicated it.

Pokaż atrybuty podrzędne
data.archived_at
string

Present when the block is archived. Retained published content remains readable.

data.created_at
string
wymagane
data.updated_at
string
wymagane
next_cursor
nullable string
wymagane

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

prev_cursor
nullable string
wymagane

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

refresh_cursor
nullable string
wymagane

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.

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.