SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
my leads

List the status history of a lead.

Every status change with who made it, when, through which channel, and the reason given. The first row is the creation.

GEThttps://app.softsolz.uk/api/v1/services/my-leads/leads/{id}/history

Recent Requests

Log in to see full request history
TimeStatusUser Agent
Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Query Params

limitinteger

Page size, 1-200 (default 50).

offsetinteger

Rows to skip.

Response

Response Body · array of objects

idintegerHistory row id.
lead_idintegerLead id.
from_statusstring | nullPrevious status, null on creation.
to_statusstringNew status.
reasonstring | nullWhy it changed.
changed_byinteger | nullMember who changed it.
changed_by_namestring | nullMember display name.
viastring | nullapi, connected_app, research or null.
via_labelstring | nullApp or key name.
changed_atstringWhen it changed.

Request

import { SoftSolz } from '@softsolz/sdk';
const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });
const result = await client.myLeads.listLeadHistory('<id>', {});
console.log(result);

Credentials

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
"data": [
{
"id": 0,
"lead_id": 0,
"from_status": "string",
"to_status": "string",
"reason": "string",
"changed_by": 0,
"changed_by_name": "string",
"via": "string",
"via_label": "string",
"changed_at": "string"
}
]
}