Get Contact List
curl --request GET \
--url https://api.politicalcomms.com/v1/contact-lists/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.politicalcomms.com/v1/contact-lists/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.politicalcomms.com/v1/contact-lists/{id}', 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.politicalcomms.com/v1/contact-lists/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-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"
"net/http"
"io"
)
func main() {
url := "https://api.politicalcomms.com/v1/contact-lists/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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://api.politicalcomms.com/v1/contact-lists/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.politicalcomms.com/v1/contact-lists/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "cl_abc123",
"list_name": "Spring Outreach List",
"org_id": "org_123",
"brand_id": "brand_abc123",
"status": "ready",
"contact_count": 12500,
"import_progress": {
"rows_total": 12500,
"rows_imported": 12500,
"rows_skipped": 0
},
"analysis": {
"mobile": 11200,
"landline": 800,
"voip": 350,
"invalid": 150,
"last_run_at": "2025-03-15T10:05:00Z"
},
"created_at": "2025-03-15T10:00:00Z"
}
}{
"success": false,
"error": "The provided API key is invalid or has been revoked",
"code": "INVALID_API_KEY",
"statusCode": 401
}{
"success": false,
"error": "API key lacks the permission scope this endpoint requires",
"code": "PERMISSION_DENIED",
"statusCode": 403
}{
"success": false,
"error": "Resource not found",
"code": "NOT_FOUND",
"statusCode": 404
}{
"success": false,
"error": "Rate limit exceeded",
"message": "Maximum 100 requests per 60 seconds",
"code": "RATE_LIMIT_EXCEEDED",
"statusCode": 429,
"retryAfter": 12
}{
"success": true,
"error": "<string>",
"code": "<string>",
"statusCode": 123
}Contact Lists
Get Contact List
Fetch a single contact list including import progress and analysis results.
GET
/
contact-lists
/
{id}
Get Contact List
curl --request GET \
--url https://api.politicalcomms.com/v1/contact-lists/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.politicalcomms.com/v1/contact-lists/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.politicalcomms.com/v1/contact-lists/{id}', 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.politicalcomms.com/v1/contact-lists/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-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"
"net/http"
"io"
)
func main() {
url := "https://api.politicalcomms.com/v1/contact-lists/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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://api.politicalcomms.com/v1/contact-lists/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.politicalcomms.com/v1/contact-lists/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "cl_abc123",
"list_name": "Spring Outreach List",
"org_id": "org_123",
"brand_id": "brand_abc123",
"status": "ready",
"contact_count": 12500,
"import_progress": {
"rows_total": 12500,
"rows_imported": 12500,
"rows_skipped": 0
},
"analysis": {
"mobile": 11200,
"landline": 800,
"voip": 350,
"invalid": 150,
"last_run_at": "2025-03-15T10:05:00Z"
},
"created_at": "2025-03-15T10:00:00Z"
}
}{
"success": false,
"error": "The provided API key is invalid or has been revoked",
"code": "INVALID_API_KEY",
"statusCode": 401
}{
"success": false,
"error": "API key lacks the permission scope this endpoint requires",
"code": "PERMISSION_DENIED",
"statusCode": 403
}{
"success": false,
"error": "Resource not found",
"code": "NOT_FOUND",
"statusCode": 404
}{
"success": false,
"error": "Rate limit exceeded",
"message": "Maximum 100 requests per 60 seconds",
"code": "RATE_LIMIT_EXCEEDED",
"statusCode": 429,
"retryAfter": 12
}{
"success": true,
"error": "<string>",
"code": "<string>",
"statusCode": 123
}Authorizations
Authenticate every request by passing your API key in the X-API-Key header. Keys are scoped to your organization hierarchy.
Path Parameters
Resource ID
⌘I
