Lead activity & follow-ups
Base URL https://api.leadx.in/api/key/protected. Every request needs an apikey header — see Authentication.
6 endpoints.
GET /lead-activity
Get all lead activities.
Auth apikey
:::note Used by the web app
pages/LeadActivities.jsx, pages/Leads.jsx
:::
Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.
Response — data is an array of LeadActivity objects, alongside the pagination fields described in Response format.
GET /lead-activity/:id
Get lead activity.
Auth apikey
:::note Used by the web app
pages/LeadActivities.jsx, pages/Leads.jsx
:::
Path parameters
| Name | |
|---|---|
id | Required |
Response — data is one LeadActivity object. (Resource deduced from the collections this handler reads, not read off an explicit return.)
Errors LeadActivityNotFound_404
PATCH /lead-activity/:id/notes
Update lead activity notes.
Auth apikey
:::note Used by the web app
pages/LeadActivities.jsx, pages/Leads.jsx
:::
Path parameters
| Name | |
|---|---|
id | Required |
Request body
| Field | Default |
|---|---|
notes | "" |
Response — data is one LeadActivity object. (Resource deduced from the collections this handler reads, not read off an explicit return.)
GET /lead-activity/follow-up
Get follow ups.
Auth apikey
Query parameters
| Field | Default |
|---|---|
lead | — |
status | upcoming |
dateFrom | — |
dateTo | — |
Response — data is one FollowUp object.
POST /lead-activity/follow-up
Create follow up.
Auth apikey
Request body
| Field | Default |
|---|---|
lead | — |
type | — |
followUpAt | — |
notes | "" |
reason | "" |
now | false |
Response — data is one FollowUp object.
PATCH /lead-activity/follow-up/:id
Update follow up.
Auth apikey
Path parameters
| Name | |
|---|---|
id | Required |
Request body
| Field | Default |
|---|---|
status | — |
reason | "" |
notes | — |
followUpAt | — |
type | — |
postponeTo | — |
Response — data is one FollowUp object.