Get an SMTP config
/v1/email/smtp/configs/{api_key_id}curl -X GET "https://us1.platform.bird.com/v1/email/smtp/configs/{api_key_id}" \
-H "Authorization: Bearer $TOKEN"{
"api_key_id": "key_01krdgeqcxet5s7t44vh8rt9mg",
"category": "marketing",
"tags": [
{
"name": "category",
"value": "welcome"
}
],
"created_at": "2026-05-20T09:14:52Z",
"updated_at": "2026-05-25T16:42:01Z"
}
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.
Parameters
api_key_idstringID of the API key the config applies to, the same key your SMTP client authenticates with.
Response Payload
api_key_idID of the API key this config applies to, the same key your SMTP client authenticates with. One config exists per key.
ip_pool_idID 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.
categoryContent 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.
Possible values: marketing, transactional
tagsStructured {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.
track_opensWhether open events are tracked for messages submitted over SMTP with this key.
track_clicksWhether click events are tracked for messages submitted over SMTP with this key.
created_atupdated_atRelated resources
Continue with the documentation, guides and examples for this topic.