List SMTP Credentials via the API

List all SMTP credentials in your AhaSend account through the API, with their scope and sending domains, using cursor-based pagination.

GET /v2/accounts/{account_id}/smtp-credentials

AhaSend Go SDK

Go

package main

import (
  "context"
  "fmt"
  "log"

  "github.com/AhaSend/ahasend-go/api"
  "github.com/google/uuid"
)

func main() {
  // Create API client with authentication
  client := api.NewAPIClient(
    api.WithAPIKey("aha-sk-your-64-character-key"),
  )

  accountID := uuid.New()

  // Create context for the API call
  ctx := context.Background()

  // Call the ping endpoint
  response, httpResp, err := client.SMTPCredentialsAPI.GetSMTPCredentials(
    ctx,
    accountID,
    nil,
    nil,
  )
  if err != nil {
    log.Fatalf("Error getting SMTP credentials: %v", err)
  }

  // Check response
  if httpResp.StatusCode == 200 {
    fmt.Printf("✅ Status: %d\n", httpResp.StatusCode)
    if response != nil {
      fmt.Printf("SMTP credentials: %#v\n", response)
    }
  } else {
    fmt.Printf("❌ Unexpected status code: %d\n", httpResp.StatusCode)
  }
}

200

{
  "object": "list",
  "data": [
    {
      "object": "credential_smtp",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "username": "<string>",
      "sandbox": true,
      "scope": "global",
      "domains": [
        "<string>"
      ]
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJpZCI6MTIzNH0="
  }
}

The AhaSend API returns a list of SMTP credentials for the account. The global read role sees all credentials; domain-scoped roles return credentials associated with at least one authorized domain.

Related Guides

• API authentication, Permission scopes, SMTP credential setup.
• SMTP credential API, SMTP credential CLI, SMTP settings.
• API errors, API rate limits, Plans and limits.

Authorizations

BearerAuthBearerAuth

Authorization · string · header · required

API key for authentication. Non-empty Security Requirement values are AhaSend API-key roles. Roles listed within one requirement object are jointly required; separate requirement objects are alternatives.

Path Parameters

account_id · string<uuid> · required

Account ID

Query Parameters

limit · integer · default: 100

Maximum number of items to return (1-100)

Required range: 1 <= x <= 100

after · string

Pagination cursor for the next page. Provide the value provided in next_cursor from the response.

before · string

Pagination cursor for the previous page.

Response

200

application/json

List of SMTP credentials

object · enum<string> · required

Object type identifier

Available options: list

data · object[] · required

Array of SMTP credentials

Show child attributes

pagination · object · required

Show child attributes

Example:

{
  "has_more": true,
  "next_cursor": "eyJpZCI6MTIzNH0="
}