API Reference

Fetch contacts

post
https://prospect-api.smartlead.ai/api/v1/search-email-leads/fetch-contacts

Fetch contact emails for a search filter or by specific adapt IDs. Requires authentication via Bearer token or API key in query parameter (?api_key=... for /api/v1/). Either provide id (array of adapt IDs) with filter_id, or limit with filter_id to fetch up to limit contacts for that filter. Limit and credit checks apply when using limit; failures return 200 with success: false and an error message.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

API key for authentication (when calling /api/v1/fetch-contacts). Without it, the request returns 401 Unauthorized.

Body Params

Either provide id (array of adapt IDs) with filter_id — then limit is not needed. Or provide limit with filter_id (no id) — then limit is required. One of these two options is required.

id
array of strings
required
length ≥ 1

Adapt IDs to fetch (use with filter_id; no limit check)

id*
number
≥ 1

Number of contacts to fetch for the filter (max 10000 or 30000 for some users). Required when not using id.

number
1 to 1000
Defaults to 10

Page size for visual pagination

number
≥ 0
Defaults to 0

Offset for visual pagination

number
required
≥ 1

Filter ID (required)

Responses

Updated 3 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago