Preview prospect search results - Sendora

POST

/

api

/

v1

/

public

/

lead-lists

/

{list_id}

/

prospect-search

/

preview

cURL

curl -X POST 'https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview' -H "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
  -d '{"filters":{"analytics_tech":["example"],"city":"example","company_name":"example"}}'

import requests

url = 'https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.post(url, headers=headers, json={'filters': {'analytics_tech': ['example'], 'city': 'example', 'company_name': 'example'}})
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview", {
  method: "POST",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"filters": {"analytics_tech": ["example"], "city": "example", "company_name": "example"}}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("POST", "https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview", bytes.NewBufferString(`{"filters": {"analytics_tech": ["example"], "city": "example", "company_name": "example"}}`))
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "results": [
    {}
  ],
  "status": "<string>",
  "error_message": "<string>",
  "total_matches": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key

string | null

Authorization

string | null

Path Parameters

list_id

string

required

The lead list's id: the id from List lead lists. It is also the last part of that page's address in the app.

Body

application/json

filters

prospectingFilters · object

required

Filters returned by the Sendora API.

Show child attributes

auto_enrich

boolean

default:true

Auto enrich returned by the Sendora API.

page

integer

default:1

Page returned by the Sendora API.

Required range: x >= 1

page_size

integer

default:100

Page size returned by the Sendora API.

Required range: 1 <= x <= 100

Response

Successful Response

id

string<uuid>

required

The preview's id. Pass it as preview_id to read or import this result set.

results

Results · object[]

required

Results returned by the Sendora API.

status

string

required

Status returned by the Sendora API.

error_message

string | null

Error message returned by the Sendora API.

total_matches

integer | null

Total matches returned by the Sendora API.

cURL

curl -X POST 'https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview' -H "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
  -d '{"filters":{"analytics_tech":["example"],"city":"example","company_name":"example"}}'

import requests

url = 'https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.post(url, headers=headers, json={'filters': {'analytics_tech': ['example'], 'city': 'example', 'company_name': 'example'}})
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview", {
  method: "POST",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"filters": {"analytics_tech": ["example"], "city": "example", "company_name": "example"}}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("POST", "https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview", bytes.NewBufferString(`{"filters": {"analytics_tech": ["example"], "city": "example", "company_name": "example"}}`))
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "results": [
    {}
  ],
  "status": "<string>",
  "error_message": "<string>",
  "total_matches": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}