List inbox conversations for a lead

curl --request POST \
  --url https://api.leadping.ai/conversations/lead/{leadId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.leadping.ai/conversations/lead/{leadId}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/conversations/lead/{leadId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{}", false);
var response = await client.PostAsync(request);

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

HttpResponse<String> response = Unirest.post("https://api.leadping.ai/conversations/lead/{leadId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.leadping.ai/conversations/lead/{leadId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.leadping.ai/conversations/lead/{leadId}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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/conversations/lead/{leadId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

{
  "items": [
    {
      "id": "<string>",
      "leadId": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "jsmith@example.com",
      "avatarUrl": "<string>",
      "lastSnippet": "<string>",
      "lastEventAt": "2023-11-07T05:31:56Z",
      "lastEventIsInternalNote": true,
      "status": "needs_reply",
      "statusReason": "<string>",
      "archivedAt": "2023-11-07T05:31:56Z",
      "archiveReason": 0,
      "isArchived": true,
      "currentLeadStatus": {
        "id": "<string>",
        "category": "Open",
        "outcome": "<string>",
        "displayName": "<string>",
        "changedAt": "2023-11-07T05:31:56Z",
        "changedByUserId": "<string>",
        "changedByAutomationId": "<string>",
        "source": "User"
      },
      "nextStep": "<string>",
      "isUnread": true,
      "phoneNumber": {
        "id": "<string>",
        "name": "<string>",
        "value": "<string>"
      },
      "leadPhoneNumber": "<string>",
      "outboundPhoneNumberOverrideId": "<string>",
      "activeOutboundPhoneNumberId": "<string>"
    }
  ],
  "pageSize": 123,
  "totalCount": 123,
  "continuationToken": "<string>"
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request could not be completed."
}

{
  "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": "Too Many Requests",
  "status": 429,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The request could not be completed."
}

POST

conversations

lead

{leadId}

List inbox conversations for a lead

curl --request POST \
  --url https://api.leadping.ai/conversations/lead/{leadId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.leadping.ai/conversations/lead/{leadId}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/conversations/lead/{leadId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{}", false);
var response = await client.PostAsync(request);

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

HttpResponse<String> response = Unirest.post("https://api.leadping.ai/conversations/lead/{leadId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.leadping.ai/conversations/lead/{leadId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.leadping.ai/conversations/lead/{leadId}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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/conversations/lead/{leadId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

{
  "items": [
    {
      "id": "<string>",
      "leadId": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "jsmith@example.com",
      "avatarUrl": "<string>",
      "lastSnippet": "<string>",
      "lastEventAt": "2023-11-07T05:31:56Z",
      "lastEventIsInternalNote": true,
      "status": "needs_reply",
      "statusReason": "<string>",
      "archivedAt": "2023-11-07T05:31:56Z",
      "archiveReason": 0,
      "isArchived": true,
      "currentLeadStatus": {
        "id": "<string>",
        "category": "Open",
        "outcome": "<string>",
        "displayName": "<string>",
        "changedAt": "2023-11-07T05:31:56Z",
        "changedByUserId": "<string>",
        "changedByAutomationId": "<string>",
        "source": "User"
      },
      "nextStep": "<string>",
      "isUnread": true,
      "phoneNumber": {
        "id": "<string>",
        "name": "<string>",
        "value": "<string>"
      },
      "leadPhoneNumber": "<string>",
      "outboundPhoneNumberOverrideId": "<string>",
      "activeOutboundPhoneNumberId": "<string>"
    }
  ],
  "pageSize": 123,
  "totalCount": 123,
  "continuationToken": "<string>"
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request could not be completed."
}

{
  "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": "Too Many Requests",
  "status": 429,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "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 ID to get conversations for.

Body

Pagination, filtering, and sorting options for the lead's conversations.

Defines cursor pagination, sorting, search, exact-match filters, and range filters for a structured API query.

pageSize

integer<int32>

Maximum number of items requested for one page; the server may enforce a lower maximum or apply a default.

continuationToken

null | string

Opaque cursor returned by the previous paged response; omit it when requesting the first page and do not parse or modify it.

orderBy

null | object[]

Sort instructions applied in priority order, with the first entry acting as the primary sort.

Show child attributes

includeCount

null | boolean

Whether the response should include the total number of matching records; counting may increase query cost or latency.

null | string

Free-text search term applied to the configured SearchFields.

searchFields

null | string[]

Serializable string field names searched for Search; supported names are determined by the queried resource.

filters

null | object[]

Exact-match conditions that require each named field to equal its supplied value.

Show child attributes

rangeFilters

null | object[]

Range conditions that constrain comparable fields with inclusive or exclusive lower and upper bounds.

Show child attributes

Response

Returns the paged conversation response.

Returns one page of query results together with page-size, optional total-count, and opaque continuation-cursor metadata.

items

object[]

Items included in the current page, in the order determined by the query.

Show child attributes

pageSize

integer<int32>

Effective page-size limit used for this response, which may differ from the requested size because of server defaults or limits.

totalCount

null | integer<int32>

Total number of records matching the query across all pages, or null when counting was not requested or computed.

continuationToken

null | string

Opaque cursor for requesting the next page, or null when no additional page is available; clients must not parse or modify it.

API Overview

Endpoints

List inbox conversations for a lead

Authorizations

Path Parameters

Body

Response