---
title: "Get automatic seeding settings"
canonical: "https://bird.com/docs/api/reference/get-automatic-seeding-settings"
---

# Get automatic seeding settings

`GET /v1/email/inbox-insights/automatic-seeding`

Read settings and the trigger address for this workspace. Requires Inbox Insights read permission. Before initial setup, the revision is zero and the trigger address is absent.

## Servers

- `https://{region}.platform.bird.com`: Regional API endpoint. Use the host for the region your organization is hosted in. Official Bird SDKs and the CLI select it automatically from your API key, so you rarely need to set it by hand.
  - `region`: `us1`, `eu1`. Default: `us1`. The region your organization's data is hosted in.

## Authentication

Use one authentication option:

- `BearerAuth`: HTTP bearer authentication. Pass the API key as a bearer token in the `Authorization` header. Workspace
keys use `bk_{region}_*`; organization master keys use `bm_{region}_*`.
The prefix identifies the region and selects the
API endpoint. Official Bird SDKs and the CLI derive the region from the key.

## Code samples

**TypeScript**

```ts
// Requires inbox_insights:read permission in the target workspace.
const settings = await bird.email.seeding.settings.get();
console.log(settings.enabled, settings.revision, settings.trigger_address);
```

Examples: [TypeScript](/docs/api/reference/get-automatic-seeding-settings.ts.md) · [Python](/docs/api/reference/get-automatic-seeding-settings.py.md) · [Go](/docs/api/reference/get-automatic-seeding-settings.go.md) · [PHP](/docs/api/reference/get-automatic-seeding-settings.php.md) · [CLI](/docs/api/reference/get-automatic-seeding-settings.cli.md) · [MCP](/docs/api/reference/get-automatic-seeding-settings.mcp.md) · [cURL](/docs/api/reference/get-automatic-seeding-settings.curl.md)

## Example response `200`

```json
{
  "revision": 3,
  "trigger_address": "4f9a2c7e1b8d4a60935ce7f2b1d0a8c3@seeds.bird.com",
  "enabled": true,
  "list_type": "private",
  "engagement_profile": "all",
  "regions": [
    "North America - US"
  ]
}
```

## Header parameters

- `X-Workspace-Id` (string, optional): Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.
- `X-Organization-Id` (string, optional): Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

## Response body

- `revision` (integer, required): Current settings revision. Supply it when updating settings. Initialize settings before rotating the trigger address.
- `trigger_address` (string): Workspace trigger address for seeding examples. Absent before the first settings update. Using it requires authenticated sending access to this workspace; the address itself grants no access.
- `enabled` (boolean, required): Saved automatic-seeding preference.
- `list_type` (string)

  Which pool of seed addresses a test uses. Which pools an account can use depends on what has been provisioned for it, so read the usable set from the seed-test options rather than assuming these are the only values.

  Possible values (may grow over time): `private`, `public`, `exclusive`
- `engagement_profile` (string)

  Which engagement behaviour the seed addresses simulate. `all` mixes engaged and dormant seeds, which is what makes an engagement split measurable; single-cohort profiles exist too, and the usable set comes from the seed-test options rather than from this list.

  Possible values (may grow over time): `all`, `engaging`, `non_engaging`
- `regions` (array of string): Saved regions to place seeds in, as `regions[].value` names from `GET /v1/email/inbox-insights/seed-tests/configuration`. They are not checked against that list when saved.

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)
