List Recipient Lists

curl --request GET \
  --url https://campaigns.sightx.io/campaigns-service/v1/recipientLists \
  --header 'Authorization: <api-key>'

import requests

url = "https://campaigns.sightx.io/campaigns-service/v1/recipientLists"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://campaigns.sightx.io/campaigns-service/v1/recipientLists', 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://campaigns.sightx.io/campaigns-service/v1/recipientLists",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://campaigns.sightx.io/campaigns-service/v1/recipientLists"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://campaigns.sightx.io/campaigns-service/v1/recipientLists")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://campaigns.sightx.io/campaigns-service/v1/recipientLists")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

Audiences/Recipient lists / Recipient lists

List Recipient Lists

Description

Find all recipient list matched by filter from the data source. If withChannels query params is set to 'true' then it will add data to each recipient:

-hasPhone: Whether the recipients list has at least one phone set for its recipients.
-hasEmail: Whether the recipients list has at least one email set for its recipients.
-recipientsCount: Number of recipients in the list.

Response

[
  {
    "name": "recipient list name",
    "createdAt": "2020-09-24T16:51:28.936Z",
    "updatedAt": "2020-09-24T16:51:28.936Z",
    "id": "recipient list id",
    "audienceId": "audience id",
    "fileKey": "file.xlsx.csv",
    "recipientsCount": 5,
    "companyId": "company id",
    "isDeleted": true,
    "hasPhone": true,
    "hasEmail": true,
  }
]

where:

name: Name of the recipient list.
createdAt: Creation date of the recipient list.
updateAt: Last date of update of the recipient list.
id: Recipient list id.
audienceId: Audience id of the audience the recipient list belongs to. Optional.
fileKey: Name of the file stored on S3 bucket. It’s the file used to create the recipient list. Optional.
recipientsCount: Number of recipients inside the list.
companyId: Company owner of the recipient list.
isDeleted: Whether the recipient list is soft deleted or not. Optional.
hasPhone: Whether or not the recipient list has at least one recipient with phone. Only shows when query param withChannels is set to 'true'. Optional.
hasEmail: Whether or not the recipient list has at least one recipient with email. Only shows when query param withChannels is set to 'true'. Optional.

GET

campaigns-service

recipientLists

List Recipient Lists

curl --request GET \
  --url https://campaigns.sightx.io/campaigns-service/v1/recipientLists \
  --header 'Authorization: <api-key>'

import requests

url = "https://campaigns.sightx.io/campaigns-service/v1/recipientLists"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://campaigns.sightx.io/campaigns-service/v1/recipientLists', 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://campaigns.sightx.io/campaigns-service/v1/recipientLists",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://campaigns.sightx.io/campaigns-service/v1/recipientLists"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://campaigns.sightx.io/campaigns-service/v1/recipientLists")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://campaigns.sightx.io/campaigns-service/v1/recipientLists")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

Description

Find all recipient list matched by filter from the data source. If withChannels query params is set to 'true' then it will add data to each recipient: -hasPhone: Whether the recipients list has at least one phone set for its recipients.
-hasEmail: Whether the recipients list has at least one email set for its recipients.
-recipientsCount: Number of recipients in the list.

Response

[
  {
    "name": "recipient list name",
    "createdAt": "2020-09-24T16:51:28.936Z",
    "updatedAt": "2020-09-24T16:51:28.936Z",
    "id": "recipient list id",
    "audienceId": "audience id",
    "fileKey": "file.xlsx.csv",
    "recipientsCount": 5,
    "companyId": "company id",
    "isDeleted": true,
    "hasPhone": true,
    "hasEmail": true,
  }
]

where:

name: Name of the recipient list.
createdAt: Creation date of the recipient list.
updateAt: Last date of update of the recipient list.
id: Recipient list id.
audienceId: Audience id of the audience the recipient list belongs to. Optional.
fileKey: Name of the file stored on S3 bucket. It’s the file used to create the recipient list. Optional.
recipientsCount: Number of recipients inside the list.
companyId: Company owner of the recipient list.
isDeleted: Whether the recipient list is soft deleted or not. Optional.
hasPhone: Whether or not the recipient list has at least one recipient with phone. Only shows when query param withChannels is set to 'true'. Optional.
hasEmail: Whether or not the recipient list has at least one recipient with email. Only shows when query param withChannels is set to 'true'. Optional.

Authorizations

Authorization

string

header

required

Access token obtained from the m2m-token endpoint.

Headers

Authorization

string

required

Response

Successful response

Export Recipient list recipients List Recipient list recipients

⌘I

Authentication

Analysis / Overview

Analysis / Question Dashboard

Analysis / Comparison/Manual Persona

Analysis / Trend

Analysis / Pivot table

Analysis / Text Dashboard

Analysis / Advanced Stats

Analysis / Automated Persona

Analysis / Buckets

Analysis / Views

Build / Create/Logic/Option/Design

Build / Users

Build / Languages

Build / Private videos

Build / Common

Build / Netquest

Distribution / Campaign

Distribution / Quotas

Distribution / Stats

Distribution / Send

Survey / Render & Capture

Survey / Languages

Projects Dashboard / Projects

Projects Dashboard / Folders

Audiences/Recipient lists / Audiences

Audiences/Recipient lists / Recipient lists

Responses / Cleaning System

Responses / Export

Responses / Import

Responses / Responses Screen

List Recipient Lists

Description

Response

Description

Response

Authorizations

Headers

Response

​Description

​Response

Authorizations

Headers

Response

Description

Response