List Suppressed Addresses via the API

List the addresses on your AhaSend suppression list through the API, filtered by email, domain or creation time, to find out why an email was not sent.

GET /v2/accounts/{account_id}/suppressions

AhaSend Go SDK

Go

package main

import (
  "context"
  "fmt"
  "log"

  "github.com/AhaSend/ahasend-go/api"
  "github.com/AhaSend/ahasend-go/models/requests"
  "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.SuppressionsAPI.GetSuppressions(
    ctx,
    accountID,
    requests.GetSuppressionsParams{},
    nil,
  )
  if err != nil {
    log.Fatalf("Error getting suppressions: %v", err)
  }

  // Check response
  if httpResp.StatusCode == 200 {
    fmt.Printf("✅ Status: %d\n", httpResp.StatusCode)
    if response != nil {
      fmt.Printf("Found %d suppressions\n", len(response.Data))
    }
  } else {
    fmt.Printf("❌ Unexpected status code: %d\n", httpResp.StatusCode)
  }
}

200

{
  "object": "list",
  "data": [
    {
      "object": "suppression",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "email": "[e-mail]",
      "domain": "<string>",
      "reason": "<string>",
      "expires_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJpZCI6MTIzNH0="
  }
}

The AhaSend API returns a list of suppressions for the account.

Query Parameters:

• domain: Filter by domain (optional)
• email: Filter by email (optional)
• from_time: Filter suppressions created after this time (RFC3339 format, optional)
• to_time: Filter suppressions created before this time (RFC3339 format, optional)
• limit: Maximum number of items to return (1-100, default: 100)
• after: Pagination cursor for the next page
• before: Pagination cursor for the previous page

Related Guides

• API authentication, Permission scopes, Suppression CLI.
• Suppression durations, API errors, API rate limits.

Authorizations

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

domain · string

Filter by domain

email · string<email>

Email address

from_time · string<date-time>

Filter suppressions created after this time (RFC3339 format)

to_time · string<date-time>

Filter suppressions created before this time (RFC3339 format)

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. Provide the value provided in previous_cursor from the response.

Response

200

application/json

List of suppressions

object · enum<string> · required

Object type identifier

Available options: list

data · object[] · required

Array of suppressions

Show child attributes

pagination · object · required

Show child attributes

Example:

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