Skip to main content
GET
AhaSend Go SDK
The AhaSend API returns the recipients of a campaign, by contact ID, highest first. Access requires campaigns:read. Send exactly one of status and bounce_classification:
  • status is a key of report.by_status in Get Campaign Stats, such as Queued, Delivered or Administratively Bounced.
  • bounce_classification is a key of report.by_bounce_classification. Unknown counts bounces with no classification and cannot be listed.
Each recipient gives the address that the campaign sent to, the list it was sent from, its status, its delivery attempts and, for a bounce, the classification, the reason and the message of the receiving server. A page after the last recipient is empty and has no previous_cursor. To start again, read the first page without a cursor.

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

campaign_id
string<uuid>
required

Campaign ID

Query Parameters

status
string

A status as a key of the stats' by_status names it, such as Queued, Delivered or Administratively Bounced.

Required string length: 1 - 64
bounce_classification
string

A key of the stats' by_bounce_classification, except Unknown, which has no recipient page.

Required string length: 1 - 255
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 from next_cursor in the response.

before
string

Pagination cursor for the previous page. Provide the value from previous_cursor in the response. An empty page past the last recipient has no previous_cursor; read the first page with no cursor.

Response

Paginated campaign recipients

object
enum<string>
required

Object type identifier

Available options:
list
data
object[]
required

Array of recipients, by contact ID, the highest first

pagination
object
required
Example: