Sign inGet Started

Get a reusable email block

GET
/v1/email/blocks/{block_id}
// Requires email_management:read permission in the target workspace.
const block = await bird.email.blocks.get("ebl_01krdgeqcxet5s7t44vh8rt9mg");
console.log(block.name, block.revision, block.archived_at);
Reactie200
{
  "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"
}

Returns a block's metadata, including archived blocks. Send its revision when updating or duplicating the block; each language's content has its own draft revision.

Parameters

block_idstring

Block to read or edit.

Response Payload

id
string
verplicht
name
string
verplicht

Name for people choosing the block, such as when linking it into a template.

description
string

Optional notes for people maintaining the block. Omitted when empty.

source_language
string
verplicht

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

revision
integer
verplicht

Metadata revision to send when editing or duplicating this block.

created_by
object
verplicht

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

Onderliggende attributen tonen
created_by.id
string
verplicht

Actor identifier.

created_by.type
string
verplicht

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

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.

archived_at
string

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

created_at
string
verplicht
updated_at
string
verplicht

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