v1

latestOpenAPI 3.1.02026-07-24700259.3 KB
SMTP USERS

View SMTP users

Returns a list of all SMTP users that are managed by this account, or details of a specific user, when you include the [username] in your request. If no users are available, this will return an empty list.

post/users/smtp/view

Request body

usernamestring

If passed, a valid SMTP2GO username of your existing SMTP User that you wish to view

subaccount_idstring

If you wish to make this API call on behalf of a subaccount then include its unique ID here

Response

List of SMTP Users

request_idstring required

Example response

{
  "request_id": "aa253464-0bd0-467a-b24b-6159dcd7be60",
  "data": {
    "results": [
      {
        "comments": "Comment explaining how amazing this Test person is",
        "username": "smtpuser@example.com",
        "email_password": "H#8dkK2djs",
        "sending_allowed": true,
        "custom_ratelimit": true,
        "custom_ratelimit_value": 100,
        "custom_ratelimit_period": "1 day",
        "default_ratelimit_period": "unlimited",
        "ippool": 1234,
        "feedback_enabled": true,
        "feedback_domain": "default",
        "archive_enabled": true,
        "open_tracking_enabled": true,
        "bounce_notifications": "from"
      }
    ]
  }
}