---
title: "Get an SMTP config"
method: GET
path: "/v1/email/smtp/configs/{api_key_id}"
tags: ["email-smtp-configs"]
---

# Get an SMTP config

`GET /v1/email/smtp/configs/{api_key_id}`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/email/smtp/configs/{api_key_id}`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

Returns the SMTP send-option config stored for the given API key. Returns a `404` if you have not set a config for that key. The key still accepts SMTP submissions, using your organization's default pool, the transactional category, and tracking on.

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

SMTP config object.

- EmailSmtpConfig
  - `api_key_id` string, required
  - `ip_pool_id` string, nullable: ID of the IP pool that SMTP sends with this key use, or `ipp_shared` for the shared pool. `null` when this key uses your organization's default pool.
  - `category` 'marketing' | 'transactional', required: Content classification applied to messages submitted over SMTP with this key. Controls suppression policy: - `marketing`: Blocks on all suppression reasons. - `transactional`: Allows delivery through complaint and unsubscribe suppressions.
  - `tags` Tag[], required: Structured `{name, value}` labels applied to every message submitted over SMTP with this key, the same tags used by the email sending API. Use tags to filter and break down your email statistics.
    - `name` string, required: Tag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.
    - `value` string, required: Tag value. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 64 characters.
  - `track_opens` boolean, required: Whether open events are tracked for messages submitted over SMTP with this key.
  - `track_clicks` boolean, required: Whether click events are tracked for messages submitted over SMTP with this key.
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/6dfce1179799?raw)