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>"
}
'
{
  "count": 123,
  "results": [
    {
      "phoneNumber": "<string>"
    }
  ]
}

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.