Skip to main content
GET
/
api
/
leads
Error
A valid request URL is required to generate request examples
[
  {
    "id": 123,
    "name": "<string>",
    "phone": "<string>",
    "email": "",
    "status": "new",
    "accountId": "<string>",
    "source": "api",
    "tags": [
      "<string>"
    ],
    "assignedAgentId": "<string>",
    "abTestId": "<string>",
    "agentAssignedBy": "auto",
    "customFields": {},
    "lastContactedAt": "2023-11-07T05:31:56Z",
    "importBatchId": "<string>",
    "externalId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

X-API-Key
string
header
required

API key prefixed with nl_live_ or nl_test_

Query Parameters

statuses
string

Comma-separated list of statuses to filter by

Example:

"new,contacted"

tags
string

Comma-separated list of tags to filter by

Example:

"vip,hot"

channel
string

Channel to filter by

limit
integer
default:50

Maximum number of leads to return

Required range: x <= 100

Response

200 - application/json

Without filters: a plain array of leads. With filters: an object containing leads array and total count.

id
integer
required

Sequential, account-scoped identifier

name
string
required
phone
string
required

Unique per account

email
string
default:""
required
status
enum<string>
required
Available options:
new,
contacted,
qualified,
disqualified
accountId
string
required
source
string
default:api
tags
string[]
assignedAgentId
string

ObjectId reference to AgentConfig

abTestId
string

ObjectId reference to AbTest

agentAssignedBy
enum<string>
default:auto
Available options:
manual,
ab_test,
auto
customFields
object

Key-value string map of custom fields

lastContactedAt
string<date-time>
importBatchId
string
externalId
string
createdAt
string<date-time>
updatedAt
string<date-time>