List audiences

GET

/v1/audiences

for await (const audience of bird.audiences.list()) {
  console.log(audience.id, audience.name);
}

for audience in client.audiences.list():
    print(audience.id, audience.name)

for audience, err := range client.Audiences.List(context.Background(), bird.AudienceListParams{Limit: 50}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(audience.Id, audience.Name)
}

foreach ($bird->audiences->list() as $audience) {
    echo $audience->getId(), ' ', $audience->getName(), "\n";
}

bird audiences list

curl -X GET "https://us1.platform.bird.com/v1/audiences" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "q=newsletter" \
  --url-query "limit=25"

Respons200

{
  "data": [
    {
      "id": "adn_01krdgeqcxet5s7t44vh8rt9mg",
      "type": "static",
      "created_at": "2026-05-20T09:14:52Z",
      "updated_at": "2026-05-25T16:42:01Z"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns a paginated list of audiences in the workspace, newest first. Filter to audiences whose name contains a substring with q.

Parameter Kueri

string

Case-insensitive substring match against the audience's name.

limit

integer

Maximum number of items to return per page.

starting_after

string

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_before

string

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

Payload Respons

data

array of object

wajib

Page of audience objects.

Tampilkan atribut turunan

data.id

string

wajib

ID of the audience, accepted by every operation that takes an audience_id.

data.name

string

wajib

Display name for the audience.

data.description

nullable string

Longer description of who this audience is.

data.type

string

wajib

How the audience's recipients are determined. static is an explicit member list you manage by adding and removing contacts.

Possible values: static

data.created_at

string

wajib

data.updated_at

string

wajib

next_cursor

nullable string

wajib

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor

nullable string

wajib

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor

nullable string

wajib

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Sumber daya terkait

Lanjutkan dengan dokumentasi, panduan, dan contoh untuk topik ini. Sumber daya tersedia dalam bahasa Inggris.

Tonton panduannyaManage your customers: contacts & audiences Jelajahi kemampuannyaContacts and audiences Ikuti jalur pembelajaranBuild your first integration Panduan implementasiAudiences

Dapatkan ringkasan implementasi

for await (const audience of bird.audiences.list()) {
  console.log(audience.id, audience.name);
}

for audience in client.audiences.list():
    print(audience.id, audience.name)

for audience, err := range client.Audiences.List(context.Background(), bird.AudienceListParams{Limit: 50}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(audience.Id, audience.Name)
}

foreach ($bird->audiences->list() as $audience) {
    echo $audience->getId(), ' ', $audience->getName(), "\n";
}

bird audiences list

curl -X GET "https://us1.platform.bird.com/v1/audiences" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "q=newsletter" \
  --url-query "limit=25"

Respons200

{
  "data": [
    {
      "id": "adn_01krdgeqcxet5s7t44vh8rt9mg",
      "type": "static",
      "created_at": "2026-05-20T09:14:52Z",
      "updated_at": "2026-05-25T16:42:01Z"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}