Export Recipient list recipients

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

import requests

url = "https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients"

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/{recipientListId}/recipients', 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/{recipientListId}/recipients",
  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/{recipientListId}/recipients"

	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/{recipientListId}/recipients")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

Export Recipient list recipients

Description

Find all recipient list recipients where recipientListId is the id to filter recipients.

Response

{
  "labels": {},
  "recipients": [
    {
      "email": string,
      "isDeleted": boolean,
      "isUnsubscribed": boolean,
      "unsubscribedAt": string,
      "unsubscribedBy": string,
      "values": object,
      "id": string,
      "recipientListId": string,
      "firstName": string,
      "lastName": string,
      "countryCode": string,
      "phone": string,
      "updatedAt": string,
      "createdAt": string,
      "externalId": number,
    }
  ],
  "totalCount": number,
}

where:

labels: Object with labels for every column indexed by column number.
recipients: Array of recipients with the following data:
- email: Recipient email. Optional.
- isDeleted: Whether or not the recipient is soft deleted or not.
- isUnsubscribed: Whether or not the recipient is unsubscribed.
- unsubscribedAt: When the recipient was unsubscribed. Optional.
- unsubscribedBy: Hash representing who unsubscribed the recipient. Optional.
- values: Object with recipient values indexed by column number.
- id: Recipient id.
- recipientListId: Recipient list id.
- firstName: Recipient first name. Optional.
- lastName: Recipient last name. Optional.
- countryCode: Country code for the phone. Optional.
- phone: Recipient phone. Optional.
- updatedAt: Last modified date.
- createdAt: Creation date.
- externalId: Id assigned by the user.
totalCount: Total recipients returned.

GET

campaigns-service

recipientLists

{recipientListId}

recipients

Export Recipient list recipients

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

import requests

url = "https://campaigns.sightx.io/campaigns-service/v1/recipientLists/{recipientListId}/recipients"

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/{recipientListId}/recipients', 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/{recipientListId}/recipients",
  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/{recipientListId}/recipients"

	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/{recipientListId}/recipients")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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 recipients where recipientListId is the id to filter recipients.

Response

{
  "labels": {},
  "recipients": [
    {
      "email": string,
      "isDeleted": boolean,
      "isUnsubscribed": boolean,
      "unsubscribedAt": string,
      "unsubscribedBy": string,
      "values": object,
      "id": string,
      "recipientListId": string,
      "firstName": string,
      "lastName": string,
      "countryCode": string,
      "phone": string,
      "updatedAt": string,
      "createdAt": string,
      "externalId": number,
    }
  ],
  "totalCount": number,
}

where:

labels: Object with labels for every column indexed by column number.
recipients: Array of recipients with the following data:
- email: Recipient email. Optional.
- isDeleted: Whether or not the recipient is soft deleted or not.
- isUnsubscribed: Whether or not the recipient is unsubscribed.
- unsubscribedAt: When the recipient was unsubscribed. Optional.
- unsubscribedBy: Hash representing who unsubscribed the recipient. Optional.
- values: Object with recipient values indexed by column number.
- id: Recipient id.
- recipientListId: Recipient list id.
- firstName: Recipient first name. Optional.
- lastName: Recipient last name. Optional.
- countryCode: Country code for the phone. Optional.
- phone: Recipient phone. Optional.
- updatedAt: Last modified date.
- createdAt: Creation date.
- externalId: Id assigned by the user.
totalCount: Total recipients returned.

Authorizations

Authorization

string

header

required

Access token obtained from the m2m-token endpoint.

Headers

Authorization

string

required

Response

Successful response

Unsubscribe a Recipient List Recipient Lists

⌘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

Export Recipient list recipients

Description

Response

Description

Response

Authorizations

Headers

Response

​Description

​Response

Authorizations

Headers

Response

Description

Response