Lead listsOperation leadLists.leads

List the leads in a list

Leads in a list.

GET/api/v1/lead-lists/{id}/leads

Scope read: Read anything in the workspace.

Parameters

Name	In	Description
`id`required	path	The record's id.

Name	In	Description
`q`	query	Search text.
`stage`	query	Pipeline stage.
`email_status`	query	valid, catch_all, invalid, unknown.
`limit`	query, integer	Rows.
`offset`	query, integer	Offset.

curl

curl -X GET "https://crm.ashwanth.dev/api/v1/lead-lists/{id}/leads" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY"

CLI

sales-engine lead-lists leads <id>

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape

{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Runs against this server, as the workspace behind the key.

API key

Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.

Path

idrequired

The record's id.

Query

q

Search text.

stage

Pipeline stage.

email_status

valid, catch_all, invalid, unknown.

limit

Rows.

offset

Offset.

Request

GET /api/v1/lead-lists/%7Bid%7D/leads

Fill the path first.