List SMTP configs
GET
/v1/email/smtp/configs
curl -X GET "https://us1.platform.bird.com/v1/email/smtp/configs" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=created_at" \
--url-query "order=desc" \
--url-query "limit=25" \
--url-query "include_total=false"Returns the SMTP send-option configs stored for API keys in this workspace, as a cursor page. Only keys with an explicitly stored config are included — a key with no config still accepts SMTP submissions, using your organization's default pool, the transactional category, and tracking on.
查询参数
sort
string
Field to sort by.
Possible values: created_at
order
string
Sort direction. Defaults to desc (newest/largest first).
Possible values: asc, desc
limit
integer
Maximum number of items to return per page.
starting_after
string
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_before
string
Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
include_total
boolean
When true, the response includes a total field with the total number of items matching the request's filters across all pages.
响应载荷
data
array of object
必填
Page of stored SMTP configs, newest first by default.
显示子属性
data.api_key_id
string
必填
ID of the API key this config applies to, the same key your SMTP client authenticates with. One config exists per key.
data.ip_pool_id
nullable string
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.
data.category
string
必填
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.
Possible values: marketing, transactional
data.tags
array of object
必填
Structured {name, value} labels applied to every message submitted over SMTP with this key — the same tags used by the email sending API. See EmailMessageSendRequest for how tags are used for filtering and analytics.
显示子属性
data.tags.name
string
必填
Tag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.
data.tags.value
string
必填
Tag value. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 64 characters.
data.track_opens
boolean
必填
Whether open events are tracked for messages submitted over SMTP with this key.
data.track_clicks
boolean
必填
Whether click events are tracked for messages submitted over SMTP with this key.
data.created_at
string
必填
data.updated_at
string
必填
next_cursor
nullable string
必填
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
必填
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
必填
Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.
total
nullable integer
Total number of items matching the request's filters across all pages. Present only when include_total=true was passed; otherwise null.