Skip to main content
GET
/
audiences
/
{audience_id}
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 audience = await client.audiences.retrieve('audience_id');

console.log(audience.id);
import os
from courier import Courier

client = Courier(
api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted
)
audience = client.audiences.retrieve(
"audience_id",
)
print(audience.id)
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"),
)
audience, err := client.Audiences.Get(context.TODO(), "audience_id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", audience.ID)
}
package com.courier.example;

import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.audiences.Audience;
import com.courier.models.audiences.AudienceRetrieveParams;

public final class Main {
private Main() {}

public static void main(String[] args) {
CourierClient client = CourierOkHttpClient.fromEnv();

Audience audience = client.audiences().retrieve("audience_id");
}
}
require "courier"

courier = Courier::Client.new(api_key: "My API Key")

audience = courier.audiences.retrieve("audience_id")

puts(audience)
<?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 {
$audience = $client->audiences->retrieve('audience_id');

var_dump($audience);
} catch (APIException $e) {
echo $e->getMessage();
}
using System;
using TryCourier;
using TryCourier.Models.Audiences;

CourierClient client = new();

AudienceRetrieveParams parameters = new() { AudienceID = "audience_id" };

var audience = await client.Audiences.Retrieve(parameters);

Console.WriteLine(audience);
courier audiences retrieve \
--api-key 'My API Key' \
--audience-id audience_id
curl --request GET \
--url https://api.courier.com/audiences/{audience_id} \
--header 'Authorization: Bearer <token>'
{
  "id": "aud_01H8M...",
  "name": "Example Name",
  "description": "An example description.",
  "operator": "AND",
  "filter": {
    "operator": "AND",
    "filters": [
      {
        "operator": "EQ",
        "path": "profile.title",
        "value": "Software Engineer"
      },
      {
        "operator": "IS_AFTER",
        "path": "profile.created_at",
        "value": "2024-01-01"
      }
    ]
  },
  "created_at": "2024-01-15T10:30:00.000Z",
  "updated_at": "2024-01-15T10:30:00.000Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

audience_id
string
required

A unique identifier representing the audience_id

Response

200 - application/json
id
string
required

A unique identifier representing the audience_id

name
string
required

The name of the audience

description
string
required

A description of the audience

created_at
string
required
updated_at
string
required
operator
enum<string>

The logical operator (AND/OR) combining the top-level filter.filters. Convenience alias for filter.operator.

Available options:
AND,
OR
filter
AudienceFilterConfig · object | null

Filter configuration for audience membership containing an array of filter rules