List email templates

GET

/v1/email/templates

for await (const tpl of bird.email.templates.list({ scope: "workspace" })) {
  console.log(tpl.slug, tpl.name);
}

for template in client.email.templates.list(scope="workspace"):
    print(template.slug, template.name)

for tpl, err := range client.Email.Templates.List(context.Background(), bird.EmailTemplatesListParams{Scope: "workspace"}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(*tpl.Slug, tpl.Name)
}

foreach ($bird->email->templates->list(['scope' => 'workspace']) as $template) {
    echo $template->getSlug(), ' ', $template->getName(), "\n";
}

bird email templates list

curl -X GET "https://us1.platform.bird.com/v1/email/templates" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "limit=25"

Respuesta200

{
  "data": [
    {
      "id": "emt_01krdgeqcxet5s7t44vh8rt9mg",
      "workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
      "slug": "welcome-email",
      "name": "Welcome email",
      "scope": "system",
      "status": "active",
      "category": "transactional",
      "source": "html",
      "theme": "arcane",
      "draft_version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
      "live_version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
      "published_version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
      "available_languages": [
        "en"
      ],
      "default_language": "pt-BR",
      "languages": {
        "en": {
          "status": "live"
        },
        "de": {
          "status": "draft"
        }
      }
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns a paginated list of email templates, newest first.

The list covers both the workspace's own templates and our built-in system templates. Use scope to get only one of the two, or leave it out to get both. When you leave it out, the workspace's own templates come first, newest first, and our built-in templates fill the rest of the list once the workspace's templates run out.

Filter further by category or authoring format, or search with q, a case-insensitive substring match against the template's slug, name, and description.

Our built-in templates come in five visual themes. Each theme ships its own set of eight emails, and the sets overlap only partly. Use theme to see one of them. A template your workspace authored has no theme, so naming one returns our built-ins alone.

Parámetros de consulta

scope

string

Filter by who owns the template. Use system for our built-in templates and workspace for the ones your workspace created. Leave it out to get both.

Possible values: system, workspace

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Understand the conceptShould I use a Bird SDK or call the API directly?Follow the learning pathBuild your first integration Implementation guideSend your first email

Get an implementation brief

for await (const tpl of bird.email.templates.list({ scope: "workspace" })) {
  console.log(tpl.slug, tpl.name);
}

for template in client.email.templates.list(scope="workspace"):
    print(template.slug, template.name)

for tpl, err := range client.Email.Templates.List(context.Background(), bird.EmailTemplatesListParams{Scope: "workspace"}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(*tpl.Slug, tpl.Name)
}

foreach ($bird->email->templates->list(['scope' => 'workspace']) as $template) {
    echo $template->getSlug(), ' ', $template->getName(), "\n";
}

bird email templates list

curl -X GET "https://us1.platform.bird.com/v1/email/templates" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "limit=25"

Respuesta200

{
  "data": [
    {
      "id": "emt_01krdgeqcxet5s7t44vh8rt9mg",
      "workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
      "slug": "welcome-email",
      "name": "Welcome email",
      "scope": "system",
      "status": "active",
      "category": "transactional",
      "source": "html",
      "theme": "arcane",
      "draft_version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
      "live_version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
      "published_version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
      "available_languages": [
        "en"
      ],
      "default_language": "pt-BR",
      "languages": {
        "en": {
          "status": "live"
        },
        "de": {
          "status": "draft"
        }
      }
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}