> ## Documentation Index > Fetch the complete documentation index at: https://developers.nlpearl.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get Lead Via External ID > Retrieves details of a specific lead within an outbound ## OpenAPI ````yaml get /v2/Outbound/{pearlId}/Lead/External/{externalId} openapi: 3.0.1 info: title: NLPearl Client API description: A sample API that demonstrates features in the OpenAPI specification version: v2 servers: - url: https://api.nlpearl.ai description: Production Environement security: - bearer_auth: [] - oauth2_client_credentials: [] tags: - name: Pearl description: >- Manage your Pearls, the AI agents that handle your inbound and outbound calls. Create and configure Pearls, retrieve their details and settings, run or pause them, list and bulk-export their calls, monitor calls in progress, get analytics, and reset a customer's conversation memory. paths: /v2/Outbound/{pearlId}/Lead/External/{externalId}: get: tags: - Outbound summary: Get Lead Via External ID description: Retrieves details of a specific lead within an outbound parameters: - name: pearlId in: path required: true schema: type: string - name: externalId in: path required: true schema: type: string responses: '200': description: Details of the specific lead. content: text/plain: schema: $ref: '#/components/schemas/LeadApiView' application/json: schema: $ref: '#/components/schemas/LeadApiView' text/json: schema: $ref: '#/components/schemas/LeadApiView' '400': description: Error content: text/plain: schema: $ref: '#/components/schemas/ValidationProblemDetails' application/json: schema: $ref: '#/components/schemas/ValidationProblemDetails' text/json: schema: $ref: '#/components/schemas/ValidationProblemDetails' components: schemas: LeadApiView: type: object properties: id: type: string description: The unique identifier of the lead, represented as an ObjectId. nullable: true externalId: type: string description: The identifier for the lead from an external system, such as a CRM. nullable: true phoneNumber: type: string description: The phone number of the lead. nullable: true timeZone: type: string description: >- The time zone of the lead, represented as a float (e.g., -5.0 for EST). nullable: true status: allOf: - $ref: '#/components/schemas/eLeadStatusView' description: >+ 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: type: string description: The date and time when the lead was created. format: date-time callsId: type: array items: type: string description: The list of the ID's of all the calls this lead has received. nullable: true callData: type: object additionalProperties: type: string description: "A dictionary containing additional information about the call.\r\nIt is used as variables that you can use in \"Opening Sentence\" or \"Flow Script\" when you create a Pearl on the platform.\r\nThe keys represent the field names, and the values contain the corresponding data.\r\nThis information can be used to personalize the conversation or manage lead-specific details.\r\nThis parameter is optional.\r\nsee [Variables](/pages/variables) for more information.\r\nHere is an example of the json to send:\r\n`{ \"email\" : \"joe@gmail.com\", \"address\": \"3 Abbey Road UK\" , \"carLicense\" : \"90-929-82\" }`" nullable: true collectedData: type: object additionalProperties: {} description: "A dictionary containing all the information collected about the lead during the call. \r\nThese values are the result of the conversation and reflect the answers or actions taken by the lead. \r\nThe `key` represents the ID of the variable configured on the platform, \r\nand the `value` corresponds to the collected data. \r\n \r\nThis information can be used to understand user intent, track specific responses, or power further automation. \r\nFor more details on how variables work, see [Variables](/pages/variables).\r\n \r\nHere is an example of the JSON format:\r\n`{ \"confirmBooking\": true, \"dropOffLocation\": \"Orly Airport\", \"rideTime\": \"Friday at 12:00\", \"userIntent\": \"Book a taxi to the airport\" }`" nullable: true additionalProperties: false ValidationProblemDetails: type: object properties: type: type: string nullable: true title: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true errors: type: object additionalProperties: type: array items: type: string nullable: true additionalProperties: {} eLeadStatusView: type: integer description: >+ 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` format: int32 securitySchemes: bearer_auth: type: http description: >- Specify the authorization token. For more information, check out the [Authorization Guide](/api-reference/authorization). scheme: bearer oauth2_client_credentials: type: oauth2 description: >- OAuth2 client_credentials grant. Use the Id of an OAuth API key as `client_id` and its one-time secret as `client_secret`. flows: clientCredentials: tokenUrl: /oauth/token scopes: pearls:read: List and view Pearls pearls:write: >- Create and update Pearls (settings, conversation flows, voices); implies pearls:read pearls:moderate: Run/pause Pearls and reset customer memory; implies pearls:read pearls:analytics: Read Pearl analytics; implies pearls:read pearls:leads: Manage and read outbound leads; implies pearls:read pearls:calls: >- Read calls and recordings, make and delete calls; implies pearls:read account:phone_numbers: Read account phone numbers and text channels account:users: Read account users account:advanced: Manage advanced account settings (blacklist) account:billing: Read account information and credit balance account:audit_log: Read the audit log tts: Synthesise speech and clone voices ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.