Skip to main content
POST
This endpoint requires authentication via API key passed as a query parameter (api_key).

Query Parameters

api_key
string
required
Your SmartLead API key for authentication

Request Body

The request body must be JSON. filter_id is required. You must provide either id (array of adapt IDs) with filter_id, or limit with filter_id. When using limit, it must be between 1 and 10000 (or 30000 for some users). Limit and credit checks apply when using limit; failures return 200 with success: false and an error message.
filter_id
number
required
Filter ID (positive number).
id
string[]
Adapt IDs to fetch (use with filter_id; no limit check). Required when not using limit.
limit
number
Number of contacts to fetch for the filter (1–10000 or 1–30000 for some users). Required when not using id.
visual_limit
number
Page size for visual pagination (1–1000, default 10).
visual_offset
number
Offset for visual pagination (≥ 0, default 0).

Response Codes

200
Success
Request successful
400
Bad Request
Bad Request
401
Unauthorized
Unauthorized
500
Internal Server Error
Internal Server Error