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"

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

Abfrageparameter

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 field of a previous list response. Returns items immediately before the cursor position in the current sort order.

Antwort-Payload

data

array of object

erforderlich

Page of audience objects.

Untergeordnete Attribute anzeigen

data.id

string

erforderlich

ID of the audience (adn_-prefixed), accepted by every operation that takes an audience_id.

data.name

string

erforderlich

Display name for the audience.

data.description

nullable string

Longer description of who this audience is.

data.type

string

erforderlich

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

erforderlich

data.updated_at

string

erforderlich

next_cursor

nullable string

erforderlich

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

prev_cursor

nullable string

erforderlich

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

refresh_cursor

nullable string

erforderlich

Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

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"