Skip to main content
POST
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Body

application/json
lead_list_id
string
required

A lead list's id: the id from List or read lead collections (type list).

company
string | null

company_employees: company LinkedIn URL or website.

countries
string[] | null

Countries returned by the Sendora API.

cursor
string | null

Cursor returned by the Sendora API.

description
string | null

Describe who you want in plain words. Used when filters is not sent.

Maximum string length: 1000
filters
Filters · object | null

Search filters. Send description instead to have them written for you.

limit
integer | null

Limit returned by the Sendora API.

Required range: 1 <= x <= 500
locations
string[] | null

google_maps: where to look.

page
integer | null

company_employees: which page of people to return.

Required range: x >= 1
page_size
integer
default:25

Page size returned by the Sendora API.

Required range: 1 <= x <= 50
query
string | null

google_maps: what to look for.

require_contact
boolean
default:false

Require contact returned by the Sendora API.

role
string | null

Role returned by the Sendora API.

style
enum<string> | null

Style returned by the Sendora API.

Available options:
best,
everyone
titles
string[] | null

Titles returned by the Sendora API.

type
enum<string>
default:people

Type returned by the Sendora API.

Available options:
people,
companies,
hiring,
company_employees,
google_maps

Response

Successful Response

id
string<uuid>
required

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

mode
string
required

Mode returned by the Sendora API.

results
Results · object[]
required

Results returned by the Sendora API.

status
string
required

Status returned by the Sendora API.

company_name
string | null

Company name returned by the Sendora API.

cursor
string | null

Cursor returned by the Sendora API.

dropped_without_profile
integer
default:0

Dropped without profile returned by the Sendora API.

error_message
string | null

Error message returned by the Sendora API.

page
integer | null

Page returned by the Sendora API.

total_matches
integer | null

Total matches returned by the Sendora API.

total_pages
integer | null

Total pages returned by the Sendora API.