List leads

Leads of the API key owner's organization, newest first (by timestamp, then lead_id), one page at a time.

Filters (all optional, combined with AND)

lead_status_id, lead_source_type_id, lead_origin_type_id: UUIDs (not case-sensitive). Get the ids from the lead_status, lead_source_type and lead_origin_type objects in lead responses.

agent_user_assignment_id: leads currently assigned to that agent.

contact_id: leads linked to that Master Contact List contact.

search: case-insensitive contains match on any lead field value or a linked contact's phone. Trimmed and cut to 100 characters; % and _ are matched literally.

An empty value is the same as not sending the filter. A malformed id (not a UUID / not a positive integer) → 9002.

Pagination

limit 1–500, default 50 (out-of-range values are clamped). offset ≥ 0, default 0.

total_count is the number of leads matching the filters, across all pages. Next page: offset += limit while offset < total_count.

Row shape is lighter than GET /crm-lead/detail: field values without type info, contacts as id + phone, agents as user_assignment_ids. Call /crm-lead/detail for the full lead.

Access

The route crm-lead GET must be in api_allowed_routes (else 9020); the user's role needs the crm-lead.read permission (else -403).

Errors

Code	Meaning
9002	A filter id is malformed
9647	CRM is not enabled for the organization
9028	Database error
9020	Route not allowed for API keys (HTTP 403)
9243	Invalid or expired API key (HTTP 401)
-403	Role lacks crm-lead.read (HTTP 403)
9999	Rate limit exceeded (HTTP 429)

application/json

Application envelope. data.leads is the page, data.total_count the number of matching leads. Errors also return HTTP 200 with status: false.

Bodyapplication/json

curl --location 'https://api.chronox.ai/api/crm-lead?limit=50&offset=0&search=ravi&lead_status_id=undefined&lead_source_type_id=undefined&lead_origin_type_id=undefined&agent_user_assignment_id=undefined&contact_id=undefined' \ --header 'Authorization: {{Authorization}}'

{ "status": true, "data": { "leads": [ { "lead_id": "3f6c2a8e-1b4d-4c1e-9a7b-2d5e8f0a1c34", "organization_id": 42, "created_by_user_assignment_id": 101, "timestamp": "2026-10-23T05:00:00.000Z", "created_at_timestamp": "2026-10-23T05:00:00.000Z", "lead_source_type_id": "b1e2c3d4-0000-4000-8000-000000000001", "lead_source_type_name": "API", "lead_origin_type_id": "d4e5f6a7-0000-4000-8000-000000000003", "lead_origin_type_name": "API", "lead_status_id": "c2d3e4f5-0000-4000-8000-000000000002", "lead_status_name": "New", "lead_status_color": "#2F80ED", "fields": [ { "lead_field_id": "d3e4f5a6-0000-4000-8000-000000000003", "lead_field_name": "Name", "value": "Ravi Patel" }, { "lead_field_id": "e4f5a6b7-0000-4000-8000-000000000004", "lead_field_name": "Email", "value": "ravi.patel@example.com" } ], "contacts": [ { "contact_id": 5678, "phone": "919876543210" } ], "agents": [ 205 ] } ], "total_count": 1 } }

Request

Responses