Email Servers
List Email Servers
Returns all email servers configured for the authenticated account
GET
Overview
Use this endpoint to retrieve theid values needed for the emailServerId field when creating or updating agents.
Sensitive fields (SMTP passwords, SendGrid API keys) are never returned.
Response Fields
| Field | Type | Description |
|---|---|---|
id | string (UUID) | Use this as emailServerId when creating or updating an agent |
name | string | Display name of the email server |
type | string | smtp or sendgrid |
is_default | boolean | Whether this is the account’s default server (used when emailServerId is omitted or null) |
smtp_host | string | null | SMTP hostname (SMTP servers only) |
smtp_port | number | null | SMTP port (SMTP servers only) |
smtp_from_email | string | null | From email address (SMTP servers only) |
smtp_from_name | string | null | From name (SMTP servers only) |
sendgrid_from_email | string | null | From email address (SendGrid servers only) |
sendgrid_from_name | string | null | From name (SendGrid servers only) |
