Export a lead's status history

curl --request GET \
  --url https://api.leadping.ai/leads/{leadId}/status-history/export \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.leadping.ai/leads/{leadId}/status-history/export"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/leads/{leadId}/status-history/export");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.leadping.ai/leads/{leadId}/status-history/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leadping.ai/leads/{leadId}/status-history/export"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/leads/{leadId}/status-history/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "fileName": "<string>",
  "contentType": "<string>",
  "csv": "<string>",
  "rows": [
    {
      "leadId": "<string>",
      "leadStatusChangeId": "<string>",
      "type": "<string>",
      "outcome": "<string>",
      "category": "Open",
      "oldLeadStatusChangeId": "<string>",
      "oldLeadStatusChangeType": "<string>",
      "oldLeadStatusChangeOutcome": "<string>",
      "newLeadStatusChangeId": "<string>",
      "changeSource": "User",
      "changedByUserId": "<string>",
      "changedByAutomationId": "<string>",
      "changedAt": "2023-11-07T05:31:56Z",
      "reason": "<string>",
      "followUpStatus": "<string>",
      "callbackAt": "2023-11-07T05:31:56Z",
      "taskDueAt": "2023-11-07T05:31:56Z",
      "appointmentStartAt": "2023-11-07T05:31:56Z",
      "appointmentEndAt": "2023-11-07T05:31:56Z",
      "assignedToUserId": "<string>",
      "sourceId": "<string>",
      "relatedCallEventId": "<string>",
      "isMissedCallFollowUp": true,
      "notes": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request could not be completed."
}

GET

leads

{leadId}

status-history

export

Export a lead's status history

curl --request GET \
  --url https://api.leadping.ai/leads/{leadId}/status-history/export \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.leadping.ai/leads/{leadId}/status-history/export"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/leads/{leadId}/status-history/export");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.leadping.ai/leads/{leadId}/status-history/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leadping.ai/leads/{leadId}/status-history/export"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/leads/{leadId}/status-history/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "fileName": "<string>",
  "contentType": "<string>",
  "csv": "<string>",
  "rows": [
    {
      "leadId": "<string>",
      "leadStatusChangeId": "<string>",
      "type": "<string>",
      "outcome": "<string>",
      "category": "Open",
      "oldLeadStatusChangeId": "<string>",
      "oldLeadStatusChangeType": "<string>",
      "oldLeadStatusChangeOutcome": "<string>",
      "newLeadStatusChangeId": "<string>",
      "changeSource": "User",
      "changedByUserId": "<string>",
      "changedByAutomationId": "<string>",
      "changedAt": "2023-11-07T05:31:56Z",
      "reason": "<string>",
      "followUpStatus": "<string>",
      "callbackAt": "2023-11-07T05:31:56Z",
      "taskDueAt": "2023-11-07T05:31:56Z",
      "appointmentStartAt": "2023-11-07T05:31:56Z",
      "appointmentEndAt": "2023-11-07T05:31:56Z",
      "assignedToUserId": "<string>",
      "sourceId": "<string>",
      "relatedCallEventId": "<string>",
      "isMissedCallFollowUp": true,
      "notes": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request could not be completed."
}

Authorizations

Authorization

string

header

required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Path Parameters

leadId

string

required

The lead identifier.

Response

Returns the lead status change export response.

Describes lead status change export data returned by Leadping.

fileName

string

Suggested file name for the exported CSV document.

contentType

string

MIME content type of the exported document.

csv

string

Complete comma-separated values content encoded as text.

rows

object[]

The rows included with this lead status change export.

Show child attributes

API Overview

Endpoints

Export a lead's status history

Authorizations

Path Parameters

Response