Skip to main content
GET
Get an accessible inbox conversation and its current event version.

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

id
string
required

The ID of the conversation to retrieve.

Response

OK

Describes conversation data returned by Leadping.

isDemo
boolean
id
string

Unique Leadping identifier for this conversation response.

leadId
string

Lead ID associated with this inbox conversation.

firstName
null | string

First name of the lead, user, or contact represented by this conversation response.

lastName
null | string

Last name of the lead, user, or contact represented by this conversation response.

email
null | string<email>

Email address used to resolve the lead's avatar when available.

avatarUrl
null | string<uri>

Optional profile image URL explicitly associated with the lead.

lastSnippet
null | string

Most recent message preview shown for the conversation.

lastEventAt
null | string<date-time>

UTC timestamp when the most recent conversation event occurred.

eventVersion
integer<int64>

Monotonic event boundary. Mark-read requests must send the version the reader observed.

lastEventIsInternalNote
boolean

Indicates that the most recent conversation activity is an internal note.

status
null | enum<string>

Defines the customer-facing operational status for an inbox conversation.

Available options:
needs_reply,
waiting,
failed,
open
statusReason
null | string

Human-readable reason explaining the current status of this conversation response.

archivedAt
null | string<date-time>

UTC timestamp when this record was archived.

archiveReason
null | enum<integer>

Defines why a lead was removed from the active working pipeline.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
isArchived
boolean

Indicates whether the Leadping conversation has been archived.

currentLeadStatus
object | null

Summary schema for Leadping API current lead status change summary data used in dashboards and reports.

nextStep
null | string

Recommended next step to move this conversation response forward.

isUnread
boolean

Indicates whether the current user has unread activity in the conversation.

phoneNumber
object | null

Extends an identifier-and-name resource reference with an optional string value used for display or selection metadata.

leadPhoneNumber
null | string

Lead's phone number used for conversation matching and outreach.

outboundPhoneNumberOverrideId
null | string

Phone number ID manually chosen to override automatic outbound selection.

activeOutboundPhoneNumberId
null | string

Phone number ID currently active for outbound delivery.