JavaScript
import Courier from '@trycourier/courier';
const client = new Courier({
apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});
const response = await client.audiences.listMembers('audience_id');
console.log(response.items);import os
from courier import Courier
client = Courier(
api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted
)
response = client.audiences.list_members(
audience_id="audience_id",
)
print(response.items)package main
import (
"context"
"fmt"
"github.com/trycourier/courier-go"
"github.com/trycourier/courier-go/option"
)
func main() {
client := courier.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Audiences.ListMembers(
context.TODO(),
"audience_id",
courier.AudienceListMembersParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Items)
}package com.courier.example;
import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.audiences.AudienceListMembersParams;
import com.courier.models.audiences.AudienceListMembersResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
CourierClient client = CourierOkHttpClient.fromEnv();
AudienceListMembersResponse response = client.audiences().listMembers("audience_id");
}
}require "courier"
courier = Courier::Client.new(api_key: "My API Key")
response = courier.audiences.list_members("audience_id")
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Courier\Client;
use Courier\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API Key');
try {
$response = $client->audiences->listMembers('audience_id', cursor: 'cursor');
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using TryCourier;
using TryCourier.Models.Audiences;
CourierClient client = new();
AudienceListMembersParams parameters = new() { AudienceID = "audience_id" };
var response = await client.Audiences.ListMembers(parameters);
Console.WriteLine(response);courier audiences list-members \
--api-key 'My API Key' \
--audience-id audience_idcurl --request GET \
--url https://api.courier.com/audiences/{audience_id}/members \
--header 'Authorization: Bearer <token>'{
"paging": {
"cursor": "MTpFWUNFRkRRN0c1WERTRTU2",
"more": true
},
"items": [
{
"added_at": "2024-01-15T10:30:00.000Z",
"audience_id": "aud_123",
"audience_version": 1,
"member_id": "abc-123",
"reason": "string"
}
]
}{
"message": "Example message text",
"type": "invalid_request_error"
}Audiences
List audience members
Get list of members of an audience.
GET
/
audiences
/
{audience_id}
/
members
JavaScript
import Courier from '@trycourier/courier';
const client = new Courier({
apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});
const response = await client.audiences.listMembers('audience_id');
console.log(response.items);import os
from courier import Courier
client = Courier(
api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted
)
response = client.audiences.list_members(
audience_id="audience_id",
)
print(response.items)package main
import (
"context"
"fmt"
"github.com/trycourier/courier-go"
"github.com/trycourier/courier-go/option"
)
func main() {
client := courier.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Audiences.ListMembers(
context.TODO(),
"audience_id",
courier.AudienceListMembersParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Items)
}package com.courier.example;
import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.audiences.AudienceListMembersParams;
import com.courier.models.audiences.AudienceListMembersResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
CourierClient client = CourierOkHttpClient.fromEnv();
AudienceListMembersResponse response = client.audiences().listMembers("audience_id");
}
}require "courier"
courier = Courier::Client.new(api_key: "My API Key")
response = courier.audiences.list_members("audience_id")
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Courier\Client;
use Courier\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API Key');
try {
$response = $client->audiences->listMembers('audience_id', cursor: 'cursor');
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using TryCourier;
using TryCourier.Models.Audiences;
CourierClient client = new();
AudienceListMembersParams parameters = new() { AudienceID = "audience_id" };
var response = await client.Audiences.ListMembers(parameters);
Console.WriteLine(response);courier audiences list-members \
--api-key 'My API Key' \
--audience-id audience_idcurl --request GET \
--url https://api.courier.com/audiences/{audience_id}/members \
--header 'Authorization: Bearer <token>'{
"paging": {
"cursor": "MTpFWUNFRkRRN0c1WERTRTU2",
"more": true
},
"items": [
{
"added_at": "2024-01-15T10:30:00.000Z",
"audience_id": "aud_123",
"audience_version": 1,
"member_id": "abc-123",
"reason": "string"
}
]
}{
"message": "Example message text",
"type": "invalid_request_error"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
A unique identifier representing the audience id
Query Parameters
A unique identifier that allows for fetching the next set of members
⌘I