Skip to navigation

List leads

Leads in the key’s workspace, oldest change first — remember the last updated_at and ask for updated_since next time to keep a copy in sync.

Query parameters

updated_sincestringOptional

ISO time — only leads changed at or after it.

created_sincestringOptional

ISO time — only leads created at or after it.

stage_idstringOptional

One stage id, or several comma-separated.

pipeline_idstringOptional
Only this pipeline.
sourcestringOptional
Only leads from this source.
tagstringOptional
Only leads with this tag.
owner_user_idstringOptional

Only this owner’s leads (none = no owner).

qstringOptional
Name, email, your id, or digits of a phone number.
sortstringOptional

updated_at (default), -updated_at, created_at, -created_at.

limitstringOptional

1–200, default 50.

cursorstringOptional

next_cursor from the previous page.

Response

Successful Response
datalist of objects
has_moreboolean
next_cursorstring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error