Get a lead automation workflow status
curl --request GET \
--url https://api.leadping.ai/leads/{id}/workflow-status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.leadping.ai/leads/{id}/workflow-status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.leadping.ai/leads/{id}/workflow-status");
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);
HttpResponse<String> response = Unirest.get("https://api.leadping.ai/leads/{id}/workflow-status")
.header("Authorization", "Bearer <token>")
.asString();const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.leadping.ai/leads/{id}/workflow-status', 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/{id}/workflow-status"
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/{id}/workflow-status",
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;
}{
"leadId": "<string>",
"runs": [
{
"id": "<string>",
"organizationId": "<string>",
"leadId": "<string>",
"automation": {
"id": "<string>",
"name": "<string>"
},
"triggerType": "<string>",
"triggerDisplay": "<string>",
"status": "<string>",
"statusDisplay": "<string>",
"currentStep": {
"id": "<string>",
"name": "<string>"
},
"currentStepOrder": 123,
"nextExecutionAt": "2023-11-07T05:31:56Z",
"lastExecutionAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"retryCount": 123,
"maxRetryCount": 123,
"nextRetryAt": "2023-11-07T05:31:56Z",
"lastErrorCode": "<string>",
"lastErrorMessage": "<string>",
"skipReasonCode": "<string>",
"skipReasonDisplay": "<string>",
"lastActionSummary": "<string>",
"actions": [
{
"id": "<string>",
"stepId": "<string>",
"stepOrder": 123,
"stepDisplayName": "<string>",
"actionType": "<string>",
"actionTypeDisplay": "<string>",
"status": "<string>",
"statusDisplay": "<string>",
"scheduledAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"skippedAt": "2023-11-07T05:31:56Z",
"retryCount": 123,
"nextRetryAt": "2023-11-07T05:31:56Z",
"userSummary": "<string>",
"safeReason": "<string>",
"failureCode": "<string>"
}
],
"events": [
{
"id": "<string>",
"stepId": "<string>",
"actionId": "<string>",
"eventType": "<string>",
"status": "<string>",
"statusDisplay": "<string>",
"summary": "<string>",
"reasonCode": "<string>",
"occurredAt": "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."
}Leads
Get a lead automation workflow status
Returns automation workflow status for one lead, including active runs, paused state, and follow-up progress for the current organization.
GET
/
leads
/
{id}
/
workflow-status
Get a lead automation workflow status
curl --request GET \
--url https://api.leadping.ai/leads/{id}/workflow-status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.leadping.ai/leads/{id}/workflow-status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.leadping.ai/leads/{id}/workflow-status");
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);
HttpResponse<String> response = Unirest.get("https://api.leadping.ai/leads/{id}/workflow-status")
.header("Authorization", "Bearer <token>")
.asString();const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.leadping.ai/leads/{id}/workflow-status', 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/{id}/workflow-status"
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/{id}/workflow-status",
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;
}{
"leadId": "<string>",
"runs": [
{
"id": "<string>",
"organizationId": "<string>",
"leadId": "<string>",
"automation": {
"id": "<string>",
"name": "<string>"
},
"triggerType": "<string>",
"triggerDisplay": "<string>",
"status": "<string>",
"statusDisplay": "<string>",
"currentStep": {
"id": "<string>",
"name": "<string>"
},
"currentStepOrder": 123,
"nextExecutionAt": "2023-11-07T05:31:56Z",
"lastExecutionAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"retryCount": 123,
"maxRetryCount": 123,
"nextRetryAt": "2023-11-07T05:31:56Z",
"lastErrorCode": "<string>",
"lastErrorMessage": "<string>",
"skipReasonCode": "<string>",
"skipReasonDisplay": "<string>",
"lastActionSummary": "<string>",
"actions": [
{
"id": "<string>",
"stepId": "<string>",
"stepOrder": 123,
"stepDisplayName": "<string>",
"actionType": "<string>",
"actionTypeDisplay": "<string>",
"status": "<string>",
"statusDisplay": "<string>",
"scheduledAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"skippedAt": "2023-11-07T05:31:56Z",
"retryCount": 123,
"nextRetryAt": "2023-11-07T05:31:56Z",
"userSummary": "<string>",
"safeReason": "<string>",
"failureCode": "<string>"
}
],
"events": [
{
"id": "<string>",
"stepId": "<string>",
"actionId": "<string>",
"eventType": "<string>",
"status": "<string>",
"statusDisplay": "<string>",
"summary": "<string>",
"reasonCode": "<string>",
"occurredAt": "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 header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.
Path Parameters
The unique identifier of the lead whose workflow status to retrieve.