Skip to main content
GET
Get lead history

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

id
string<uuid>
required

Lead ID

Query Parameters

channel
string

Comma-separated channel filter. Valid values: call, whatsapp, email, system. Example: channel=call,whatsapp. The system channel covers meetings, conversions, and activities.

limit
integer
default:50

Maximum number of history items to return (default 50, max 200)

Required range: 1 <= x <= 200
offset
integer
default:0

Pagination offset

Required range: x >= 0
exclude_author_name
string

Exclude an exact author display name.

type
string

Comma-separated history item types.

orderBy
enum<string>
default:asc

Chronological order.

Available options:
asc,
desc

Response

Lead history retrieved successfully

success
boolean
required
lead
object
required
history
object[]
required
pagination
object
required
Last modified on September 8, 2026