Get an organization suppression entry
curl --request GET \
--url https://api.leadping.ai/suppressions/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.leadping.ai/suppressions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.leadping.ai/suppressions/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.get("https://api.leadping.ai/suppressions/{id}")
.header("Authorization", "Bearer <token>")
.asString();const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.leadping.ai/suppressions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.leadping.ai/suppressions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.leadping.ai/suppressions/{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 => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "<string>",
"organizationId": "<string>",
"recipientIdentifier": "<string>",
"normalizedPhoneNumber": "<string>",
"normalizedEmail": "jsmith@example.com",
"channel": "<string>",
"source": "<string>",
"status": "<string>",
"reason": "<string>",
"suppressedAt": "2023-11-07T05:31:56Z",
"releasedAt": "2023-11-07T05:31:56Z",
"audit": [
{
"id": "<string>",
"status": "<string>",
"source": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"actorId": "<string>",
"reason": "<string>",
"safeMetadata": {}
}
]
}{
"type": "about:blank",
"title": "Unauthorized",
"status": 401,
"detail": "The request could not be completed."
}{
"type": "about:blank",
"title": "Forbidden",
"status": 403,
"detail": "The request could not be completed."
}{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "The request could not be completed."
}{
"type": "about:blank",
"title": "Too Many Requests",
"status": 429,
"detail": "The request could not be completed."
}Suppressions
Get an organization suppression entry
Returns one suppression entry for the current organization, including its recipient, channel, reason, status, and audit timestamps.
GET
/
suppressions
/
{id}
Get an organization suppression entry
curl --request GET \
--url https://api.leadping.ai/suppressions/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.leadping.ai/suppressions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.leadping.ai/suppressions/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.get("https://api.leadping.ai/suppressions/{id}")
.header("Authorization", "Bearer <token>")
.asString();const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.leadping.ai/suppressions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.leadping.ai/suppressions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.leadping.ai/suppressions/{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 => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "<string>",
"organizationId": "<string>",
"recipientIdentifier": "<string>",
"normalizedPhoneNumber": "<string>",
"normalizedEmail": "jsmith@example.com",
"channel": "<string>",
"source": "<string>",
"status": "<string>",
"reason": "<string>",
"suppressedAt": "2023-11-07T05:31:56Z",
"releasedAt": "2023-11-07T05:31:56Z",
"audit": [
{
"id": "<string>",
"status": "<string>",
"source": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"actorId": "<string>",
"reason": "<string>",
"safeMetadata": {}
}
]
}{
"type": "about:blank",
"title": "Unauthorized",
"status": 401,
"detail": "The request could not be completed."
}{
"type": "about:blank",
"title": "Forbidden",
"status": 403,
"detail": "The request could not be completed."
}{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "The request could not be completed."
}{
"type": "about:blank",
"title": "Too Many Requests",
"status": 429,
"detail": "The request could not be completed."
}Authorizations
Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.
Path Parameters
The unique identifier of the suppression entry to retrieve.
Response
OK
Describes a recipient suppression that prevents outreach through one or more communication channels.
Unique Leadping identifier for the suppression entry.
Identifier of the organization that owns the suppression entry.
Provider or customer identifier used to recognize the suppressed recipient.
Suppressed phone number normalized to a consistent format.
Suppressed email address normalized for matching.
Communication channel affected by the suppression, such as SMS, voice, email, or all channels.
System or workflow that created the suppression.
Current lifecycle state, such as active or released.
Human-readable reason the recipient was suppressed or subsequently released.
UTC timestamp when the suppression became active.
UTC timestamp when the suppression was released, or null while it remains active.
Chronological audit history of suppression and release changes.
Show child attributes
Show child attributes