Filter Leads

POST 
/v1/open-api/lead/filter

Filter leads. Returns a paginated PageableData of summary rows.

Requires grant PERMISSION_OPEN_API_LEAD:READ.

Request

Responses

200

Page of matching leads.

400

Validation error (400). Field-level failures are listed in errors[] and error is null; a malformed / unparsable JSON body is the inverse — error.messageCode is 3705 and errors[] is empty.

401

Invalid, revoked or expired token (401) — also returned when the connection was revoked or the company is blocked.

Produced by the authentication filter, so the body is a reduced envelope: no error, no requestId, and errors is null rather than []. Every cause yields the same fixed English message.

403

The token lacks the required permission:scope grant (403).

429

Rate limit of 60 requests/minute exceeded (429). Like 401, this comes from the authentication filter: reduced envelope, fixed English message, no error object and no Retry-After header.