---
title: "Get Lead Via External ID"
method: GET
path: "/v2/Outbound/{pearlId}/Lead/External/{externalId}"
tags: ["Outbound"]
---

# Get Lead Via External ID

`GET /v2/Outbound/{pearlId}/Lead/External/{externalId}`

Retrieves details of a specific lead within an outbound

## Path parameters

- `pearlId` string, required
- `externalId` string, required

## Response `200`

Details of the specific lead.

- LeadApiView
  - `id` string, nullable — The unique identifier of the lead, represented as an ObjectId.
  - `externalId` string, nullable — The identifier for the lead from an external system, such as a CRM.
  - `phoneNumber` string, nullable — The phone number of the lead.
  - `timeZone` string, nullable — The time zone of the lead, represented as a float (e.g., -5.0 for EST).
  - `status` integer — The Status of the lead is the status of the last conversation. To determine the definition of 'Success' or 'Not Successful,' please refer to the [Create a Pearl](/pages/create_pearl#pearl-name) page at step 4. `1 - New` `10 - NeedRetry` `20 - InCallQueue` `30 - WrongCountryCode` `40 - OnCall` `70 - VoiceMailLeft` `100 - Success` `110 - NotSuccessful` `130 - Completed` `150 - Unreachable` `220 - Blacklisted` `500 - Error`
  - `created` string, date-time — The date and time when the lead was created.
  - `callsId` string[], nullable — The list of the ID's of all the calls this lead has received.
  - `lastCall` LeadLastCallApiView
    - `id` string, nullable — The unique identifier of the call.
    - `startTime` string, date-time — The date and time when the call processing started.
    - `pearlId` string, nullable — The ID of the Pearl Used in This Call.
    - `status` integer — Represents the current status of a call. `3 - InProgress` `4 - Completed` `5 - Busy` `6 - Failed` `7 - NoAnswer` `8 - Canceled` `10 - OnGoingText`
    - `from` string, nullable — The phone number from which the call was made.
    - `name` string, nullable — The name associated with the call, if available.
    - `collectedData` CallCollectedDataApiView
      - `transcript` AgentChatMessageApiView[], nullable — The transcript of the conversation.
        - `role` integer — `2 - Pearl` `3 - Client` `4 - PlatformUser`
        - `content` string, nullable — The content of the message
        - `startTime` number, float, nullable — The moment the message starts
        - `endTime` number, float, nullable — The moment the message ends
      - `collectedInfos` CollectedInfoView[], nullable — The information collected during the conversations.
        - `id` string, nullable — The ID of the variable collected
        - `name` string, nullable — The display name of the variable collected.
        - `value` unknown
    - `summary` string, nullable — A summary of the conversation.
    - `duration` integer — The duration of the call in seconds.
    - `recording` string, nullable — The URL of the recording of the call, if available.
    - `tags` string[], nullable — The tags or labels triggered during the conversation
  - `callData` object, nullable — A dictionary containing additional information about the call. It is used as variables that you can use in "Opening Sentence" or "Flow Script" when you create a Pearl on the platform. The keys represent the field names, and the values contain the corresponding data. This information can be used to personalize the conversation or manage lead-specific details. This parameter is optional. see [Variables](/pages/variables) for more information. Here is an example of the json to send: `{ "email" : "joe@gmail.com", "address": "3 Abbey Road UK" , "carLicense" : "90-929-82" }`
  - `collectedData` object, nullable — A dictionary containing all the information collected about the lead during the call. These values are the result of the conversation and reflect the answers or actions taken by the lead. The `key` represents the ID of the variable configured on the platform, and the `value` corresponds to the collected data. This information can be used to understand user intent, track specific responses, or power further automation. For more details on how variables work, see [Variables](/pages/variables). Here is an example of the JSON format: `{ "confirmBooking": true, "dropOffLocation": "Orly Airport", "rideTime": "Friday at 12:00", "userIntent": "Book a taxi to the airport" }`

## Other responses

- `400` — Error

---

[API](https://skmtc.net/nlpearl/apis/nlpearl-client-api.md) · [All operations](https://skmtc.net/nlpearl/apis/nlpearl-client-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nlpearl/nlpearl-client-api/versions/52d64fc5d6e9/schema)