Skip to main content
GET
List leads

Authorizations

Authorization
string
header
required

An organization API key, created in Settings → Connections → API keys. Keys start with mk_live_. Marro stores only a hash of a key, so it is shown once, when it is created: copy it then. Revoking a key ends its access at once. To replace a key without downtime, create the new one, switch your server to it, then revoke the old one. Changes made with a key appear on the lead’s timeline as made by the person who created the key, via the API. Scopes: leads.read (Read leads), leads.write (Create and update leads), leads.capture (Capture leads).

Query Parameters

limit
integer
default:25

How many leads to return, 1–100.

Required range: 1 <= x <= 100
cursor
integer

The nextCursor from the previous page.

Required range: x <= 2147483647
updated_since
string<date-time>

Only leads changed at or after this time, for syncing.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
stage_id
integer

Only leads in this stage (IDs from GET /api/v1/lead-stages).

Required range: x <= 2147483647
pipeline_id
integer

Only leads in this pipeline (IDs from GET /api/v1/pipelines).

Required range: x <= 2147483647
source_id
integer

Only leads from this source (IDs from GET /api/v1/lead-sources).

Required range: x <= 2147483647
owner_id
integer

Only leads owned by this person (IDs from GET /api/v1/users).

Required range: x <= 2147483647
filter
string

A JSON array of field filters: [{"field":"city","operator":"contains","value":"Hyd"}]. All filters must match. The operators each field type takes are in this parameter’s x-filter-operators.

Maximum string length: 8000

Response

A page of leads.

items
object[]
required
nextCursor
integer | null
required

Pass as cursor for the next page; null on the last page.

Required range: 0 < x <= 2147483647