ListAudiences

Audience

POST /rpc/Builder/ListAudiences

ListAudiences

cURL

curl --request POST \
  --url https://api.sequence.app/rpc/Builder/ListAudiences \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Key: <api-key>' \
  --data '
{
  "projectId": 123
}
'

import requests

url = "https://api.sequence.app/rpc/Builder/ListAudiences"

payload = { "projectId": 123 }
headers = {
    "X-Access-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Access-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({projectId: 123})
};

fetch('https://api.sequence.app/rpc/Builder/ListAudiences', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequence.app/rpc/Builder/ListAudiences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'projectId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Access-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequence.app/rpc/Builder/ListAudiences"

	payload := strings.NewReader("{\n  \"projectId\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Access-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequence.app/rpc/Builder/ListAudiences")
  .header("X-Access-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"projectId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequence.app/rpc/Builder/ListAudiences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Access-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"projectId\": 123\n}"

response = http.request(request)
puts response.read_body

200

{
  "audiences": [
    {
      "id": 123,
      "projectId": 123,
      "name": "<string>",
      "contactCount": 123,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>"
    }
  ]
}

{
  "error": "WebrpcEndpoint",
  "code": 0,
  "msg": "endpoint error",
  "status": 400,
  "cause": "<string>"
}

{
  "error": "WebrpcBadResponse",
  "code": -5,
  "msg": "bad response",
  "status": 500,
  "cause": "<string>"
}

Authorizations

X-Access-Key · string · header · required

Public project access key for authenticating requests obtained on Sequence Builder. Example Test Key: AQAAAAAAAEGvyZiWA9FMslYeG_yayXaHnSI

Body

application/json

projectId · number

Response

200

application/json

OK

audiences · object[]

[]Audience

Show child attributes