Skip to main content
POST
/
v2
/
Account
/
Blacklist
/
Search
Search Blacklist
curl --request POST \
  --url https://api.nlpearl.ai/v2/Account/Blacklist/Search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "skip": 123,
  "limit": 123,
  "sortProp": "<string>",
  "isAscending": true,
  "search": "<string>"
}
'
import requests

url = "https://api.nlpearl.ai/v2/Account/Blacklist/Search"

payload = {
"skip": 123,
"limit": 123,
"sortProp": "<string>",
"isAscending": True,
"search": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
skip: 123,
limit: 123,
sortProp: '<string>',
isAscending: true,
search: '<string>'
})
};

fetch('https://api.nlpearl.ai/v2/Account/Blacklist/Search', 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.nlpearl.ai/v2/Account/Blacklist/Search",
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([
'skip' => 123,
'limit' => 123,
'sortProp' => '<string>',
'isAscending' => true,
'search' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$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.nlpearl.ai/v2/Account/Blacklist/Search"

payload := strings.NewReader("{\n \"skip\": 123,\n \"limit\": 123,\n \"sortProp\": \"<string>\",\n \"isAscending\": true,\n \"search\": \"<string>\"\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
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.nlpearl.ai/v2/Account/Blacklist/Search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"skip\": 123,\n \"limit\": 123,\n \"sortProp\": \"<string>\",\n \"isAscending\": true,\n \"search\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.nlpearl.ai/v2/Account/Blacklist/Search")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"skip\": 123,\n \"limit\": 123,\n \"sortProp\": \"<string>\",\n \"isAscending\": true,\n \"search\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "count": 123,
  "results": [
    {
      "phoneNumber": "<string>"
    }
  ]
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"errors": {}
}

Authorizations

Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Body

skip
integer<int32>

Number of entries to skip for pagination.

limit
integer<int32>

Limit on the number of entries to return.

sortProp
string | null

Property name to sort by.

isAscending
boolean

Whether the sort order is ascending.

search
string | null

A phone number or partial phone number.

Max 50 characters only.

Response

The paginated list of blacklist phone numbers.

count
integer<int64>

The total number of items matching the search criteria.

results
object[] | null

The list of results for the current page, based on the search criteria.