Skip to main content
GET
AhaSend Go SDK
The AhaSend API returns the members of one list, newest membership first. Access requires lists:read. Each item is a membership with its subscription_status, the contact_id and the email address of the contact. See Memberships. Filters:
  • subscription_status is unconfirmed, confirmed, unsubscribed or complained. confirmed gives the members that a campaign to the list can reach, after the account-wide checks of the contact. See Lists.
  • email matches one email address exactly, after it is trimmed and changed to lowercase. An empty value returns all members.
  • include_contacts=true adds the whole contact to each item. It also needs the contacts:read scope. Without it, the request answers 403, also for a list that does not exist.
Pages use cursors: send after or before, not both. See Pagination.

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

list_id
string<uuid>
required

List ID

Query Parameters

limit
integer
default:100

Maximum number of memberships 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

subscription_status
enum<string>

Per-list consent filter

Available options:
unconfirmed,
confirmed,
unsubscribed,
complained
email
string<email>

Exact email filter. The value is normalized before it is compared, so one that is empty or all whitespace filters nothing and the full collection is returned. It is compared against the address as stored, so an address that was stored unnormalized renders normalized in this collection and is still not matched by this filter.

include_contacts
boolean

Embed the whole contact in every item. Requires the contacts:read scope in addition to lists:read.

Response

Paginated list memberships

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