List reusable email blocks
/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);
}# Requires email_management:read permission in the target workspace.
for block in client.email.blocks.list(q="footer", archived=False):
print(block.id, block.name, block.source_language)// Requires email_management:read permission in the target workspace.
client, err := bird.NewClient(option.WithAPIKey(os.Getenv("BIRD_API_KEY")))
if err != nil {
log.Fatal(err)
}
for block, err := range client.Email.Blocks.List(context.Background(), bird.EmailBlocksListParams{Q: "footer"}) {
if err != nil {
log.Fatal(err)
}
fmt.Println(block.Id, block.Name, block.SourceLanguage)
}// Requires email_management:read permission in the target workspace.
foreach ($bird->email->blocks->list(['q' => 'footer', 'archived' => false]) as $block) {
echo $block->getId(), ' ', $block->getName(), ' ', $block->getSourceLanguage(), "\n";
}bird email blocks listcurl -X GET "https://us1.platform.bird.com/v1/email/blocks" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=created_at" \
--url-query "order=desc" \
--url-query "limit=25" \
--url-query "include_total=false"{
"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.
Paramètres de requête
sortstringField to sort by. Defaults to created_at.
Possible values: created_at, name
orderstringSort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.
Possible values: asc, desc
limitintegerMaximum number of items to return per page.
starting_afterstringCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_beforestringCursor 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_totalbooleanWhen true, the response includes a total field with the total number of items matching the request's filters across all pages.
qstringCase-insensitive text to match within the block name.
archivedbooleanReturn only archived blocks when true, or only active blocks when false.
Contenu de la réponse
datanext_cursorCursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.
prev_cursorCursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.
refresh_cursorRefresh 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.
totalTotal number of items matching the request's filters across all pages. Present only when include_total=true was passed, and omitted otherwise.
Ressources associées
Poursuivez avec la documentation, les guides et les exemples sur ce sujet.