Skip to main content
GET
AhaSend Go SDK
The AhaSend API returns the account’s contacts, newest first. Access requires contacts:read. Filters:
  • email matches one email address exactly, after it is trimmed and changed to lowercase.
  • status is enabled, disabled or blocked.
  • subscribed filters by the account-wide unsubscribe of the contact. It does not look at list memberships.
  • from_time and to_time limit the creation time. Both are RFC 3339 times, and both ends are included.
Pages use cursors: send after or before, not both. See Pagination. To list the contacts of one list, use List Contacts on a List.

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

limit
integer
default:100

Maximum number of contacts to return

Required range: 1 <= x <= 100
after
string

Cursor for the next page; cannot be combined with before

before
string

Cursor for the previous page; cannot be combined with after

email
string<email>

Normalized exact email filter

status
enum<string>

Contact status filter

Available options:
enabled,
disabled,
blocked
subscribed
boolean

Filter by global subscription state

from_time
string<date-time>

Include contacts created at or after this RFC3339 time

to_time
string<date-time>

Include contacts created at or before this RFC3339 time

Response

Paginated contacts

object
enum<string>
required
Available options:
list
data
object[]
required
pagination
object
required