---
title: "Get Lead"
method: GET
path: "/v1/lead/{lead_id}"
tags: ["lead"]
---

# Get Lead

`GET /v1/lead/{lead_id}`

## Request

- Base URL: `https://client.api.prod.orsay.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://client.api.prod.orsay.ai/v1/lead/{lead_id}`
- Auth: HTTP bearer

## Path parameters

- `lead_id` string, uuid, required

## Query parameters

- `include_feedback` boolean: Include message feedback data in the response

## Response `200`

Successful Response

- LeadResponse
  - `IsActive` boolean, required
  - `KeepAgentOnManualReply` boolean, nullable
  - `Classification` string, required
  - `ConversationHistory` Message[], required
    - `MessageId` string, uuid, nullable
    - `Content` string, nullable, required
    - `Inbound` boolean, required
    - `Timestamp` string, date-time, required
    - `IsDeleted` boolean, nullable
    - `ExternalMessageId` string, nullable
    - `Status` 'sending' | 'sent' | 'delivered' | 'read' | 'failed' | 'deleted' | 'played'
    - `StatusError` string, nullable
    - `Feedback` MessageFeedback
      - `FeedbackContent` string, required
      - `isSatisfactory` boolean, required
    - `Type` string, nullable
    - `SentBy` string, nullable
    - `Buttons` object[], nullable
    - `QuickReplies` object[], nullable
    - `MediaType` string, nullable
    - `AudioUrl` string, nullable
    - `ScheduledMessageID` string, nullable
    - `PendingApproval` boolean, nullable
    - `ContentUnavailable` boolean, nullable
  - `UpcomingMessages` Message[], required
    - `MessageId` string, uuid, nullable
    - `Content` string, nullable, required
    - `Inbound` boolean, required
    - `Timestamp` string, date-time, required
    - `IsDeleted` boolean, nullable
    - `ExternalMessageId` string, nullable
    - `Status` 'sending' | 'sent' | 'delivered' | 'read' | 'failed' | 'deleted' | 'played'
    - `StatusError` string, nullable
    - `Feedback` MessageFeedback
      - `FeedbackContent` string, required
      - `isSatisfactory` boolean, required
    - `Type` string, nullable
    - `SentBy` string, nullable
    - `Buttons` object[], nullable
    - `QuickReplies` object[], nullable
    - `MediaType` string, nullable
    - `AudioUrl` string, nullable
    - `ScheduledMessageID` string, nullable
    - `PendingApproval` boolean, nullable
    - `ContentUnavailable` boolean, nullable
  - `LeadInformation` LeadInformation, required
    - `LeadID` string, required
    - `FirstName` string, required
    - `LastName` string, nullable, required
    - `PhoneNumber` string, required
    - `CreatedAt` string, date-time, required
    - `LeadIntegration` string, required
    - `OrgId` string, required
    - `ProfilePictureURL` string, nullable
    - `Username` string, nullable
    - `BusinessWhatsappPhoneNumber` string, nullable
    - `BusinessInstagramUsername` string, nullable
    - `AssignedToUserId` string, nullable
    - `IsPersonalWhatsapp` boolean
    - `SequenceID` string, nullable
    - `SequenceName` string, nullable
    - `SequenceActive` boolean, nullable
  - `Channel` string, required
  - `TriggerDetails` TriggerDetailsResponse, required
    - `TriggerType` 'CONTACT_CREATED' | 'CONTACT_SUBSCRIBED_TO_SEQUENCE' | 'WHATSAPP_MESSAGE' | 'INSTAGRAM_COMMENT' | 'INSTAGRAM_MESSAGE' | 'INSTAGRAM_STORY_REPLY', required
    - `TextContent` string, nullable, required
    - `ExternalID` string, required
    - `MediaURL` string, nullable, required
    - `ExternalURL` string, nullable, required
    - `SourceMediaId` string, nullable
    - `Timestamp` string, date-time, required
  - `AgentName` string, nullable
  - `SendingBlocked` SendingBlockedInfo: Set when the channel this conversation runs on cannot currently send, so the UI can say it up front instead of showing messages that quietly fail.
    - `Reason` string, required
    - `PhoneNumber` string, nullable
    - `Detail` string, nullable
  - `Events` ConversationEventResponse[]
    - `EventID` string, required
    - `Type` string, required
    - `Timestamp` string, date-time, required
    - `CreatedAt` string, date-time, required
    - `Detail` string, nullable
    - `RelatedContent` string, nullable
  - `Summary` ConversationSummaryResponse
    - `Overview` string, required
    - `CurrentStatus` string, nullable
    - `InterestLevel` string, required
    - `Needs` string[]
    - `Budget` string, nullable
    - `Timeline` string, nullable
    - `QualificationAnswers` string[]
    - `Objections` string[]
    - `OpenQuestions` string[]
    - `ImportantNotes` string[]
    - `NextStep` string, nullable
    - `RecommendedActions` RecommendedActionResponse[]
      - `Type` string, required
      - `Title` string, required
      - `Reason` string, nullable
      - `Priority` string, required
      - `Timing` string, nullable
    - `Language` string, nullable
    - `GeneratedAt` string, date-time, required
    - `MessageCount` integer, required
  - `LeadLanguage` string, nullable

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-16** `ded10b609e50`: 1 info
  - added the optional property `LeadLanguage` to the response with the `200` status
- **2026-10-15** `fece7e1717b5`: 1 info
  - added the optional property `Summary/anyOf[subschema #1: ConversationSummaryResponse]/RecommendedActions` to the response with the `200` status
- **2026-10-14** `18fd5f1e3eaa`: 1 info
  - added the optional property `Summary` to the response with the `200` status
- **2026-09-15** `3f05f805151d`: 1 info
  - added the optional property `KeepAgentOnManualReply` to the response with the `200` status
- **2026-09-13** `5d70ccc0c98a`: 4 info
  - added the optional property `Events` to the response with the `200` status
  - added the optional property `LeadInformation/SequenceActive` to the response with the `200` status
  - added the optional property `LeadInformation/SequenceID` to the response with the `200` status
  - added the optional property `LeadInformation/SequenceName` to the response with the `200` status

[Operation history](https://skmtc.dev/orsay/apis/orsay-api/changes/v1/lead/:lead_id/get.md)

---

[API](https://skmtc.dev/orsay/apis/orsay-api.md) - [All operations](https://skmtc.dev/orsay/apis/orsay-api/llms.txt) - [OpenAPI document](https://skmtc.dev/orsay/apis/orsay-api/revisions/988a26cafef5?raw)