Get a List via the API

Retrieve one AhaSend contact list by ID with its name, description, tags and contact_count, the number of subscribers a campaign to it would reach.

GET /v2/accounts/{account_id}/lists/{list_id}

AhaSend Go SDK

Go

package main

import (
  "context"
  "fmt"
  "log"
  "os"

  "github.com/AhaSend/ahasend-go/api"
  "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.GetList(ctx, accountID, listID)
  if err != nil {
    log.Fatalf("Error getting list: %v", err)
  }
  fmt.Printf("%s (%d contacts)\n", response.Name, response.ContactCount)
}

200

{
  "object": "contact_list",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "contact_count": 1
}

The AhaSend API returns one list of the account. Access requires lists:read.

contact_count is the number of members that a campaign to the list would reach. See Lists for what it counts. To read the members, use List Contacts on a List.

A list that was deleted answers 404.

Related Guides

• API authentication, Permission scopes, Update List.
• Lists API overview, 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

list_id · string<uuid> · required

List ID

Response

200

application/json

List

A static, private, single opt-in container of contacts, and the unit a campaign targets.

object · enum<string> · required

Object type identifier

Available options: contact_list

id · string<uuid> · required

Unique identifier for the list

created_at · string<date-time> · required

When the list was created

updated_at · string<date-time> · required

When the list was last updated

name · string · required

List name; names are not unique within an account

description · string · required

Free-text description; empty when none was given

tags · string[] · required

Always present; an empty array when the list carries no tags

contact_count · integer · required

The list's subscribers: the members a campaign to this list would reach. A member counts when its membership is confirmed and the contact is enabled, not unsubscribed from everything, and not found invalid by validation. It is the same number the dashboard shows.

Required range: x >= 0