Sign inGet Started

List published block revisions

GET
/v1/email/blocks/{block_id}/languages/{language}/revisions
// Requires email_management:read permission in the target workspace.
for await (const revision of bird.email.blocks.languages.revisions.list(
  "ebl_01krdgeqcxet5s7t44vh8rt9mg",
  "en",
)) {
  console.log(revision.id, revision.version_number, revision.published_at);
}
Resposta200
{
  "data": [
    {
      "id": "ebr_01krdgeqcxet5s7t44vh8rt9mg",
      "version_number": 1,
      "serializer_version": 2,
      "authoring_mode": "html",
      "source_revision_id": "ebr_01krdgeqcxet5s7t44vh8rt9mg",
      "published_by": {
        "id": "usr_01krdgeqcxet5s7t44vh8rt9mg",
        "type": "user"
      },
      "published_at": "2026-05-25T16:42:01Z",
      "created_at": "2026-05-25T16:42:01Z"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns the retained publications of the exact language, highest version_number first by default. A version_number counts publications of the language and is separate from the draft revision. Drafts that were never published are not listed.

Parâmetros

block_idstring

Block to read or edit.

languagestring

Exact block language as a BCP-47 tag. No fallback is applied.

Parâmetros de consulta

sortstring

Field to sort by. Defaults to version_number.

Possible values: version_number

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.

Payload de resposta

data
array of object
obrigatório
Mostrar atributos secundários
data.id
string
obrigatório
data.version_number
integer
obrigatório

Publication number within this block language. A draft's revision is the value to send back when saving, not a publication number.

data.serializer_version
integer
obrigatório

Format used to save and render this section: 2 for a section written as HTML, 1 for one built in the Bird dashboard's visual editor.

data.authoring_mode
string
obrigatório

How this language is edited. html content is written as HTML and can be changed through the API, CLI and MCP. visual content is built in the Bird dashboard's visual editor; outside the dashboard, a visual section can still be copied by duplicating its block or restoring a published revision. The mode follows from the stored content and cannot be set directly. New values may be added; treat an unknown value as content you cannot edit through the API, CLI or MCP.

Possible values (may grow over time): visual, html

data.source_revision_id
string

Source-language revision used for this translation. Omitted when untracked.

data.published_by
object
obrigatório

Who published this revision.

Mostrar atributos secundários
data.published_by.id
string
obrigatório

Actor identifier.

data.published_by.type
string
obrigatório

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.published_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.published_at
string
obrigatório
data.created_at
string
obrigatório
next_cursor
nullable string
obrigatório

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

prev_cursor
nullable string
obrigatório

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

refresh_cursor
nullable string
obrigatório

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.