Skip to main content
POST
/
api
/
leads
/
preview
Error
A valid request URL is required to generate request examples
{
  "leads": [
    {
      "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"
    }
  ],
  "total": 123
}

Authorizations

X-API-Key
string
header
required

API key prefixed with nl_live_ or nl_test_

Body

application/json
filters
object
required
channel
string
skip
integer
limit
integer
default:5

Response

Filtered leads preview

leads
object[]
required
total
integer
required