> ## Documentation Index > Fetch the complete documentation index at: https://ahasend.com/docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > AhaSend stores all message data in the EU. See /facts. > The API base URL is https://api.ahasend.com. Send the API key in the Authorization: Bearer header. See /api-reference/authentication. > Use send.ahasend.com for SMTP. Ports 25, 587 and 2525 use STARTTLS. Port 465 is not supported. See /smtp. > For send-only integrations, create an API Key v2 under Credentials → Add and scope it to messages:send:{your-domain}. See /send-api/credentials and /api-reference/scopes. # List the Contacts on a List via the API > List the members of an AhaSend contact list with their per-list subscription status. Filter by status or email, and embed the whole contact. 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](/docs/api-reference/lists/overview#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](/docs/api-reference/lists/overview#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](/docs/api-reference/lists/overview#pagination). ## Related Guides * [API authentication](/docs/api-reference/authentication), [Permission scopes](/docs/api-reference/scopes), [Batch Add List Contacts](/docs/api-reference/lists/batch-add-list-contacts). * [Lists API overview](/docs/api-reference/lists/overview), [API errors](/docs/api-reference/errors), [API rate limits](/docs/api-reference/rate-limits). ## OpenAPI ````yaml openapi.yaml GET /v2/accounts/{account_id}/lists/{list_id}/contacts openapi: 3.1.0 info: title: AhaSend API v2 description: > The AhaSend API v2 allows you to send transactional emails, manage domains, webhooks, routes, API keys, and view statistics. ## Authentication All API requests must be authenticated using a Bearer token in the Authorization header: ``` Authorization: Bearer aha-sk-64-CHARACTER-RANDOM-STRING ``` ## Scopes API keys have specific scopes that control access to different resources and actions: ### Message Scopes - `messages:send:all` - Send messages from any domain in the account - `messages:send:{domain}` - Send messages from a specific domain - `messages:cancel:all` - Cancel messages from any domain - `messages:cancel:{domain}` - Cancel messages from a specific domain - `messages:read:all` - Read messages from any domain - `messages:read:{domain}` - Read messages from a specific domain ### Domain Scopes - `domains:read` - Read all domains - `domains:write` - Create and update domains - `domains:delete:all` - Delete any domain - `domains:delete:{domain}` - Delete a specific domain ### Account Scopes - `accounts:read` - Read account information - `accounts:write` - Update account settings - `accounts:billing` - Access billing information - `accounts:members:read` - Read account members - `accounts:members:add` - Add account members - `accounts:members:update` - Update account members - `accounts:members:remove` - Remove account members ### Webhook Scopes - `webhooks:read:all` - Read all webhooks - `webhooks:read:{domain}` - Read webhooks for a specific domain - `webhooks:write:all` - Create and update webhooks - `webhooks:write:{domain}` - Create and update webhooks for a specific domain - `webhooks:delete:all` - Delete any webhook - `webhooks:delete:{domain}` - Delete webhooks for a specific domain ### Route Scopes - `routes:read:all` - Read all routes - `routes:read:{domain}` - Read routes for a specific domain - `routes:write:all` - Create and update routes - `routes:write:{domain}` - Create and update routes for a specific domain - `routes:delete:all` - Delete any route - `routes:delete:{domain}` - Delete routes for a specific domain ### Suppression Scopes - `suppressions:read` - Read suppressions - `suppressions:write` - Create suppressions - `suppressions:delete` - Delete suppressions - `suppressions:wipe` - Delete the account's suppressions except protected ones (dangerous) ### Template Scopes - `templates:read` - Read transactional templates, their drafts and their published versions, and campaign templates - `templates:write` - Create and update transactional templates, and publish, discard and restore their drafts; create and update campaign templates - `templates:delete` - Delete transactional templates and campaign templates ### Campaign Scopes - `campaigns:read` - Read campaigns, their stats and their recipients - `campaigns:write` - Create, update and duplicate campaigns - `campaigns:delete` - Delete draft campaigns - `campaigns:send` - Send, unschedule and test-send campaigns ### Contact Scopes - `contacts:read` - Read contacts - `contacts:write` - Create and update contacts - `contacts:delete` - Delete contacts ### Contact lifecycle and attributes Contacts are account-global. A contact created through this API joins no list on its own; campaigns target lists, so add it to one with the Lists endpoints before a campaign can reach it. Contact subscription state and suppression records are independent: creating, updating, unsubscribing, resubscribing, or deleting a contact never creates, changes, or removes complaint, permanent, or protected suppressions. Prefer unsubscribe over delete when the goal is only to stop marketing mail, because unsubscribe is reversible and preserves contact history. Writable attribute keys and types come from the account's contact-attribute definitions managed in the dashboard; this API does not expose property definition CRUD. Writes accept only canonical values for those definitions, while reads remain legacy-safe and can return any recursively nested JSON value previously stored. An email used as `{id_or_email}` is a raw SDK argument and must be percent-encoded exactly once as a URL path segment by an HTTP client. For example, do not pre-encode `user+tag@example.com` before passing it to an SDK that encodes path parameters. ### List Scopes - `lists:read` - Read lists and list membership - `lists:write` - Create and update lists, and add or remove their contacts - `lists:delete` - Delete lists ### Lists and membership A list is a static, private, single opt-in container of contacts, and it is what a campaign targets. A membership carries its own `subscription_status` (`unconfirmed`, `confirmed`, `unsubscribed`, or `complained`), which is per-list consent and is independent of the contact's account-wide `unsubscribed` flag. A membership created without a status named is `confirmed`, because that is what a campaign reaches. `complained` is the mailbox provider's verdict, never writable, and a membership holding it is frozen. Deleting a list keeps its memberships, so an unsubscribe survives it. Removing a contact from a list deletes the membership row and discards that record with it, which is why unsubscribing is the reversible way to stop marketing mail on one list. Expanding a list's members with `include_contacts=true` requires `contacts:read` in addition to `lists:read`. ### SMTP Credentials Scopes - `smtp-credentials:read:all` - Read all SMTP credentials - `smtp-credentials:read:{domain}` - Read SMTP credentials for a specific domain - `smtp-credentials:write:all` - Create SMTP credentials - `smtp-credentials:write:{domain}` - Create SMTP credentials for a specific domain - `smtp-credentials:delete:all` - Delete any SMTP credentials - `smtp-credentials:delete:{domain}` - Delete SMTP credentials for a specific domain ### Statistics Scopes - `statistics-transactional:read:all` - Read all transactional statistics - `statistics-transactional:read:{domain}` - Read transactional statistics for a specific domain ### API Key Scopes - `api-keys:read` - Read API keys - `api-keys:write` - Create and update API keys - `api-keys:delete` - Delete API keys ### Sub-Account Scopes - `sub-accounts:read` - List and read sub accounts under the parent - `sub-accounts:write` - Create and update sub accounts - `sub-accounts:delete` - Soft-delete sub accounts - `sub-accounts:suspend` - Pause and resume sub accounts, and unpause their domains - `sub-accounts:usage` - Read per-sub-account usage and allocated cost - `sub-account-api-keys:read` - List and read API keys owned by sub accounts - `sub-account-api-keys:write` - Create and update API keys owned by sub accounts - `sub-account-api-keys:delete` - Delete API keys owned by sub accounts ## Rate Limiting - General API endpoints: 100 requests per second, 200 burst - Statistics endpoints: 1 request per second, 1 burst ## Pagination List endpoints use cursor-based pagination with the following parameters: - `limit`: Maximum number of items to return (default: 100, max: 100) - `after`: Pass `pagination.next_cursor` to fetch the next page - `before`: Pass `pagination.previous_cursor` to fetch the previous page `after` and `before` are mutually exclusive. A legacy `cursor` query may be accepted by parts of the server for backwards compatibility, but it is not part of the v2 public contract. ## Time Formats All timestamps must be in RFC3339 format, e.g., `2023-12-25T10:30:00Z` ## Idempotency The operations that explicitly declare the optional `Idempotency-Key` header support idempotency. Other POST operations do not gain idempotency implicitly. When the header is provided: - A fresh execution does not return `Idempotent-Replayed`. - A completed stored response is replayed with its original status and body and `Idempotent-Replayed: true`. - An unexpired in-progress execution returns HTTP 409 with `Idempotent-Replayed: false` and a positive integer `Retry-After` header. - Reusing a key with a different HTTP method, resolved request path, or request body returns HTTP 422. That response has neither `Idempotent-Replayed` nor `Retry-After`. - For ordinary idempotent operations, deterministic 2xx and 4xx outcomes produced after the idempotency middleware are stored and replayed. Authentication and IP-allow-list failures happen before idempotency and are therefore not stored. - The two secret-bearing API-key create operations use manual encrypted completion. They store and replay a successful 201, including the same one-time `secret_key`; a controller-produced 4xx is not stored and leaves the key in progress until its execution lease expires. - Server errors (5xx), handler failures, and panics are not stored. The key is released so retrying the same request with the same key re-executes it. The v2 API does not use an HTTP 412 failed-key tombstone. - Idempotency keys for non-secret responses expire after 24 hours. - Encrypted API-key creation replay responses expire after 5 minutes. ## IP Allow Lists Each API key can carry an `ip_allow_list`: a set of source IPs that restrict where the key may authenticate from. - Entries are CIDR blocks (e.g. `203.0.113.0/24`) or bare IPv4/IPv6 addresses (stored as a `/32` or `/128`). They are canonicalized and de-duplicated; the allow-all prefixes `0.0.0.0/0` and `::/0` are rejected, and at most 100 entries are allowed after de-duplication (a longer list is rejected with HTTP 400). - An empty list (the default) places no restriction. - When the list is non-empty, any authenticated request whose client IP is not covered by an entry is rejected with HTTP 403 on every v2 endpoint, regardless of the key's scopes. - Manage the list with the `ip_allow_list` field on the API-key create and update endpoints (including the sub-account API-key endpoints). - When a key updates its own `ip_allow_list` to a value that excludes the caller's current IP, the update is rejected with HTTP 409 to prevent self-lockout. Updating a sub-account key from a parent key has no such guard. version: 2.0.0 contact: email: support@ahasend.com license: name: MIT identifier: MIT servers: - url: https://api.ahasend.com description: Production server security: - BearerAuth: [] tags: - name: Utility description: Utility endpoints for health checks and diagnostics - name: API Keys description: Manage API keys for authentication and access control - name: Domains description: Manage sending domains - name: Messages description: Send and manage transactional messages - name: Accounts description: Manage account settings and members - name: Contacts description: Read, create, update, batch upsert, and delete account-global contacts - name: Templates description: >- Create, change, publish and delete the account's transactional templates, and read them with their drafts, their published versions and the variables a send must supply - name: Campaign Templates description: >- Create, change, read and delete the account's campaign templates, the designs a campaign copies when it is made from one - name: Campaigns description: >- Create, change, read, duplicate, delete, test and send the account's marketing campaigns, and read their stats and recipients - name: Lists description: Manage contact lists and the contacts on them - name: Suppressions description: Manage email suppressions - name: Routes description: Manage inbound email routing - name: Webhooks description: Manage webhook notifications - name: SMTP Credentials description: Manage SMTP authentication credentials - name: Statistics description: Access transactional email statistics - name: Message Events description: Webhooks for outbound message delivery events - name: Suppression Events description: Webhooks for suppression list changes - name: Domain Events description: Webhooks for domain configuration issues - name: Route Events description: Webhooks for inbound email routing paths: /v2/accounts/{account_id}/lists/{list_id}/contacts: get: tags: - Lists summary: List Contacts on a List description: | Returns one list's members, newest first on the membership's own `(created_at, id)`. Each item carries the membership, its `contact_id`, and the contact's normalized email; `include_contacts=true` embeds the whole contact and additionally requires the `contacts:read` scope. `after` and `before` are mutually exclusive. `subscription_status=confirmed` answers who a campaign on this list can reach, subject to the account-wide checks campaign initialization also applies. The filter accepts `complained` as well, because such a membership exists and must be findable even though no caller can write that status. operationId: getListContacts parameters: - name: account_id in: path required: true description: Account ID schema: type: string format: uuid - name: list_id in: path required: true description: List ID schema: type: string format: uuid - name: limit in: query description: Maximum number of memberships to return schema: type: integer minimum: 1 maximum: 100 default: 100 - name: after in: query description: Cursor for the next page; cannot be combined with `before` schema: type: string - name: before in: query description: Cursor for the previous page; cannot be combined with `after` schema: type: string - name: subscription_status in: query description: Per-list consent filter schema: type: string enum: - unconfirmed - confirmed - unsubscribed - complained - name: email in: query description: | 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. schema: type: string format: email - name: include_contacts in: query description: | Embed the whole contact in every item. Requires the `contacts:read` scope in addition to `lists:read`. schema: type: boolean responses: '200': description: Paginated list memberships content: application/json: schema: $ref: '#/components/schemas/PaginatedListContactsResponse' '400': description: Malformed `list_id`, invalid filter, or invalid cursor content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: | Missing `lists:read` scope, or `include_contacts=true` without the `contacts:read` scope. The expansion check runs before the list is resolved, so an unauthorized expansion naming a list that does not exist answers 403 rather than 404. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: List not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: - lists:read x-code-samples: - lang: go label: AhaSend Go SDK source: | package main import ( "context" "fmt" "log" "os" "github.com/AhaSend/ahasend-go" "github.com/AhaSend/ahasend-go/api" "github.com/AhaSend/ahasend-go/models/requests" "github.com/google/uuid" ) func main() { client := api.NewAPIClient(api.WithAPIKey(os.Getenv("AHASEND_API_KEY"))) accountID := uuid.MustParse(os.Getenv("AHASEND_ACCOUNT_ID")) ctx := context.Background() listID := uuid.MustParse("11111111-1111-4111-8111-111111111111") response, _, err := client.ListsAPI.GetListContacts(ctx, accountID, listID, requests.GetListContactsParams{ SubscriptionStatus: ahasend.String(requests.ListContactStatusConfirmed), }) if err != nil { log.Fatalf("Error listing list contacts: %v", err) } for _, member := range response.Data { fmt.Printf("%s %s\n", member.Email, member.SubscriptionStatus) } } - lang: javascript label: Node.js 22+ (AhaSend SDK) source: | import { AhaSendClient } from "@ahasend/sdk"; const client = AhaSendClient.fromEnv(); const listId = "00000000-0000-4000-8000-000000000010"; const page = await client.lists.contacts.list(listId, { subscription_status: "confirmed", limit: 20, }); console.log("List members listed.", { count: page.data.length }); components: schemas: PaginatedListContactsResponse: type: object additionalProperties: false required: - object - data - pagination properties: object: type: string enum: - list data: type: array items: $ref: '#/components/schemas/ListContact' pagination: $ref: '#/components/schemas/ContactPagination' ErrorResponse: type: object description: | Human-readable API error. The server currently sends no stable machine error code. In particular, clients must not parse `message` to distinguish IP-allow-list, scope, ownership, plan, self-lockout, suppression-duplicate, or other errors that share an HTTP status. additionalProperties: false required: - message properties: message: type: string description: Error description example: message: Error message ListContact: type: object additionalProperties: false description: | One contact's membership of one list. It carries no id of its own: a membership is addressed by the `(list_id, contact_id)` pair. required: - object - list_id - contact_id - email - subscription_status - subscribed_at - unsubscribed_at - created_at - updated_at properties: object: type: string enum: - list_contact description: Object type identifier list_id: type: string format: uuid description: The list this membership is on contact_id: type: string format: uuid description: The contact this membership belongs to email: type: string format: email description: The contact's normalized email address subscription_status: type: string enum: - unconfirmed - confirmed - unsubscribed - complained description: | Per-list consent, independent of the contact's account-wide `unsubscribed` flag. `complained` is the mailbox provider's verdict and is never writable. subscribed_at: type: - string - 'null' format: date-time description: | When consent was given. Set when the membership becomes `confirmed` and left alone afterwards, so it records when consent was given rather than when it was last re-asserted. unsubscribed_at: type: - string - 'null' format: date-time description: | When the membership became `unsubscribed`, or when the complaint landed for a `complained` membership. Cleared when the membership becomes `confirmed` again. created_at: type: string format: date-time description: When the membership was created updated_at: type: string format: date-time description: When the membership was last updated contact: $ref: '#/components/schemas/Contact' description: | The whole contact. Present only on `GET /v2/accounts/{account_id}/lists/{list_id}/contacts` with `include_contacts=true`. list: $ref: '#/components/schemas/EmbeddedContactList' description: | The list this membership is on. Present only on `GET /v2/accounts/{account_id}/contacts/{id_or_email}/lists`. ContactPagination: type: object additionalProperties: false required: - has_more - next_cursor - previous_cursor properties: has_more: type: boolean description: Whether another page exists in the requested direction next_cursor: type: - string - 'null' description: Pass as `after` to fetch the next page previous_cursor: type: - string - 'null' description: Pass as `before` to fetch the previous page Contact: type: object additionalProperties: false description: | Public contact projection. Attribute reads are legacy-safe: values can contain null, booleans, numbers, strings, arrays, or nested objects even though new writes accept only canonical dashboard-defined values. required: - object - id - created_at - updated_at - email - first_name - last_name - status - status_reason - unsubscribed - unsubscribed_at - attributes - validation_status - last_validated_at properties: object: type: string enum: - contact description: Object type identifier id: type: string format: uuid description: Unique identifier for the contact created_at: type: string format: date-time description: When the contact was created updated_at: type: string format: date-time description: When the contact was last updated email: type: string format: email description: Normalized contact email address first_name: type: string last_name: type: string status: type: string enum: - enabled - disabled - blocked status_reason: type: string unsubscribed: type: boolean unsubscribed_at: type: - string - 'null' format: date-time attributes: type: object additionalProperties: $ref: '#/components/schemas/JSONValue' validation_status: type: string enum: - unvalidated - valid - invalid - risky - unknown last_validated_at: type: - string - 'null' format: date-time EmbeddedContactList: type: object additionalProperties: false description: | The list as a membership carries it: a `contact_list` without `contact_count`, which no membership read pays for. required: - object - id - created_at - updated_at - name - description - tags properties: object: type: string enum: - contact_list description: Object type identifier id: type: string format: uuid description: Unique identifier for the list created_at: type: string format: date-time description: When the list was created updated_at: type: string format: date-time description: When the list was last updated name: type: string description: List name; names are not unique within an account description: type: string description: Free-text description; empty when none was given tags: type: array description: Always present; an empty array when the list carries no tags items: type: string JSONValue: description: Any recursively nested JSON value stored in a contact attribute oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array items: $ref: '#/components/schemas/JSONValue' - type: object additionalProperties: $ref: '#/components/schemas/JSONValue' securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: aha-sk-64-CHARACTER-RANDOM-STRING description: | 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.