---
title: "Search Leads"
method: POST
path: "/v1/Outbound/{outboundId}/Leads"
tags: ["Outbound"]
---

# Search Leads

`POST /v1/Outbound/{outboundId}/Leads`

Retrieves the leads associated with a specific outbound

## Path parameters

- `outboundId` string, required

## Request body

- LeadSearch — Extends TableSearch to include specific search criteria for leads.
  - `skip` integer — Number of entries to skip for pagination.
  - `limit` integer — Limit on the number of entries to return.
  - `sortProp` string, nullable — Property name to sort by.
  - `isAscending` boolean — Whether the sort order is ascending.
  - `statuses` ELeadStatusInputView[], nullable — Optional filters for the status of the leads. Only leads with this status will be included in the results.
  - `searchInput` string, nullable — Text to filter by.

## Response `200`

List of leads for the outbound.

- LeadListApiViewTableSearchResult
  - `count` integer — The total number of items matching the search criteria.
  - `results` LeadListApiView[], nullable — The list of results for the current page, based on the search criteria.
    - `id` string, nullable — The unique ID of the lead.
    - `externalId` string, nullable — The external ID of the lead, typically from a CRM request or another external source.
    - `phoneNumber` string, nullable — The phone number of the lead.
    - `timeZoneId` string, nullable — The time zone of the lead.
    - `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.
    - `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" }`

## 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)