> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# EmailBison: Get All Leads

> Retrieve a list of all leads for the authenticated user. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Retrieve a list of all leads for the authenticated user.

> [!NOTE]
>
> Tool ID: `emailbison_get_all_leads`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'emailbison_get_all_leads',
  {
    "search": "software companies hiring engineers",
    "filters": {},
    "filters.lead_campaign_status": "example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute emailbison_get_all_leads --input '{
  "search": "software companies hiring engineers",
  "filters": {},
  "filters.lead_campaign_status": "example"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "data": [
      {
        "id": 123,
        "uuid": "uuid_123",
        "first_name": "Jane"
      }
    ],
    "links": {
      "first": "example",
      "last": "example",
      "prev": "example"
    },
    "meta": {
      "current_page": 123,
      "from": 123,
      "last_page": 123
    }
  }
}
```

Use `deepline describe emailbison_get_all_leads --json` for the latest machine-readable contract.

## Input reference

Retrieve a list of all leads for the authenticated user.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.search` | `string` | No | — | Search term for filtering replies. |
| `payload.filters` | `object` | No | — | — |
| `payload.filters.lead_campaign_status` | `string` | No | — | Filter by lead campaign status. One of `in_sequence`, `sequence_finished`, `sequence_stopped`, `never_contacted`, `replied`. |
| `payload.filters.emails_sent` | `array` | No | — | Filter by the number of emails sent. |
| `payload.filters.emails_sent.criteria` | `string` | No | — | Comparison operator for emails sent. One of `=`, `>=`, `>`, `<=`, `<`. |
| `payload.filters.emails_sent.value` | `integer` | No | — | Value for the number of emails sent. |
| `payload.filters.opens` | `object` | No | — | — |
| `payload.filters.opens.criteria` | `string` | No | — | Comparison operator for email opens. One of `=`, `>=`, `>`, `<=`, `<`. |
| `payload.filters.opens.value` | `integer` | No | — | Value for the number of email opens. |
| `payload.filters.replies` | `object` | No | — | — |
| `payload.filters.replies.criteria` | `string` | No | — | Comparison operator for replies. One of `=`, `>=`, `>`, `<=`, `<`. |
| `payload.filters.replies.value` | `integer` | No | — | Value for the number of replies. |
| `payload.filters.verification_statuses` | `array` | No | — | A verification status. Accepted values: `verifying`, `verified`, `risky`, `unknown`, `unverified`, `inactive`, `bounced`, `unsubscribed` |
| `payload.filters.tag_ids` | `array` | No | — | Filter by tag IDs. |
| `payload.filters.excluded_tag_ids` | `array` | No | — | Exclude leads by tag IDs. |
| `payload.filters.without_tags` | `boolean` | No | — | Only show leads that have no tags attached. |
| `payload.filters.created_at` | `object` | No | — | — |
| `payload.filters.created_at.criteria` | `string` | No | — | Comparison operator for the created\_at date. One of `=`, `>=`, `>`, `<=`, `<`. |
| `payload.filters.created_at.value` | `string` | No | — | Value for the created\_at date. Must be a valid date in YYYY-MM-DD format. |
| `payload.filters.updated_at` | `object` | No | — | — |
| `payload.filters.updated_at.criteria` | `string` | No | — | Comparison operator for the updated\_at date. One of `=`, `>=`, `>`, `<=`, `<`. |
| `payload.filters.updated_at.value` | `string` | No | — | Value for the updated\_at date. Must be a valid date in YYYY-MM-DD format. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieve a list of all leads for the authenticated user.",
    "properties": {
      "search": {
        "type": [
          "string",
          "null"
        ],
        "description": "Search term for filtering replies."
      },
      "filters": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "filters.lead_campaign_status": {
        "type": "string",
        "description": "Filter by lead campaign status. One of `in_sequence`, `sequence_finished`, `sequence_stopped`, `never_contacted`, `replied`."
      },
      "filters.emails_sent": {
        "type": "array",
        "description": "Filter by the number of emails sent.",
        "items": {
          "type": "string"
        }
      },
      "filters.emails_sent.criteria": {
        "type": "string",
        "description": "Comparison operator for emails sent. One of `=`, `>=`, `>`, `<=`, `<`."
      },
      "filters.emails_sent.value": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Value for the number of emails sent."
      },
      "filters.opens": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "filters.opens.criteria": {
        "type": "string",
        "description": "Comparison operator for email opens. One of `=`, `>=`, `>`, `<=`, `<`."
      },
      "filters.opens.value": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Value for the number of email opens."
      },
      "filters.replies": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "filters.replies.criteria": {
        "type": "string",
        "description": "Comparison operator for replies. One of `=`, `>=`, `>`, `<=`, `<`."
      },
      "filters.replies.value": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Value for the number of replies."
      },
      "filters.verification_statuses": {
        "type": "array",
        "description": "A verification status. Accepted values: `verifying`, `verified`, `risky`, `unknown`, `unverified`, `inactive`, `bounced`, `unsubscribed`",
        "items": {
          "type": "string"
        }
      },
      "filters.tag_ids": {
        "type": "array",
        "description": "Filter by tag IDs.",
        "items": {
          "type": "integer"
        }
      },
      "filters.excluded_tag_ids": {
        "type": "array",
        "description": "Exclude leads by tag IDs.",
        "items": {
          "type": "integer"
        }
      },
      "filters.without_tags": {
        "type": "boolean",
        "description": "Only show leads that have no tags attached."
      },
      "filters.created_at": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "filters.created_at.criteria": {
        "type": "string",
        "description": "Comparison operator for the created_at date. One of `=`, `>=`, `>`, `<=`, `<`."
      },
      "filters.created_at.value": {
        "type": [
          "string",
          "null"
        ],
        "description": "Value for the created_at date. Must be a valid date in YYYY-MM-DD format."
      },
      "filters.updated_at": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "filters.updated_at.criteria": {
        "type": "string",
        "description": "Comparison operator for the updated_at date. One of `=`, `>=`, `>`, `<=`, `<`."
      },
      "filters.updated_at.value": {
        "type": [
          "string",
          "null"
        ],
        "description": "Value for the updated_at date. Must be a valid date in YYYY-MM-DD format."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `array` | No | — | — |
| `result.data.data[].id` | `integer` | No | — | — |
| `result.data.data[].uuid` | `string` | No | — | — |
| `result.data.data[].first_name` | `string` | No | — | — |
| `result.data.data[].last_name` | `string` | No | — | — |
| `result.data.data[].email` | `string` | No | — | — |
| `result.data.data[].title` | `string` | No | — | — |
| `result.data.data[].company` | `string` | No | — | — |
| `result.data.data[].notes` | `string` | No | — | — |
| `result.data.data[].status` | `string` | No | — | — |
| `result.data.data[].custom_variables` | `array` | No | — | — |
| `result.data.data[].custom_variables[].name` | `string` | No | — | — |
| `result.data.data[].custom_variables[].value` | `string` | No | — | — |
| `result.data.data[].lead_campaign_data` | `array` | No | — | — |
| `result.data.data[].overall_stats` | `object` | No | — | — |
| `result.data.data[].overall_stats.emails_sent` | `integer` | No | — | — |
| `result.data.data[].overall_stats.opens` | `integer` | No | — | — |
| `result.data.data[].overall_stats.replies` | `integer` | No | — | — |
| `result.data.data[].overall_stats.unique_replies` | `integer` | No | — | — |
| `result.data.data[].overall_stats.unique_opens` | `integer` | No | — | — |
| `result.data.data[].created_at` | `string` | No | — | — |
| `result.data.data[].updated_at` | `string` | No | — | — |
| `result.data.links` | `object` | No | — | — |
| `result.data.links.first` | `string` | No | — | — |
| `result.data.links.last` | `string` | No | — | — |
| `result.data.links.prev` | `string` | No | — | — |
| `result.data.links.next` | `string` | No | — | — |
| `result.data.meta` | `object` | No | — | — |
| `result.data.meta.current_page` | `integer` | No | — | — |
| `result.data.meta.from` | `integer` | No | — | — |
| `result.data.meta.last_page` | `integer` | No | — | — |
| `result.data.meta.links` | `array` | No | — | — |
| `result.data.meta.links[].url` | `string` | No | — | — |
| `result.data.meta.links[].label` | `string` | No | — | — |
| `result.data.meta.links[].active` | `boolean` | No | — | — |
| `result.data.meta.path` | `string` | No | — | — |
| `result.data.meta.per_page` | `integer` | No | — | — |
| `result.data.meta.to` | `integer` | No | — | — |
| `result.data.meta.total` | `integer` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "uuid": {
                  "type": "string"
                },
                "first_name": {
                  "type": "string"
                },
                "last_name": {
                  "type": "string"
                },
                "email": {
                  "type": "string"
                },
                "title": {
                  "type": "string"
                },
                "company": {
                  "type": "string"
                },
                "notes": {
                  "type": "string"
                },
                "status": {
                  "type": "string"
                },
                "custom_variables": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "lead_campaign_data": {
                  "type": "array"
                },
                "overall_stats": {
                  "type": "object",
                  "properties": {
                    "emails_sent": {
                      "type": "integer"
                    },
                    "opens": {
                      "type": "integer"
                    },
                    "replies": {
                      "type": "integer"
                    },
                    "unique_replies": {
                      "type": "integer"
                    },
                    "unique_opens": {
                      "type": "integer"
                    }
                  },
                  "additionalProperties": false
                },
                "created_at": {
                  "type": "string"
                },
                "updated_at": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "links": {
            "type": "object",
            "properties": {
              "first": {
                "type": "string"
              },
              "last": {
                "type": "string"
              },
              "prev": {
                "type": "string"
              },
              "next": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "meta": {
            "type": "object",
            "properties": {
              "current_page": {
                "type": "integer"
              },
              "from": {
                "type": "integer"
              },
              "last_page": {
                "type": "integer"
              },
              "links": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "url": {
                      "type": "string"
                    },
                    "label": {
                      "type": "string"
                    },
                    "active": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "path": {
                "type": "string"
              },
              "per_page": {
                "type": "integer"
              },
              "to": {
                "type": "integer"
              },
              "total": {
                "type": "integer"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [EmailBison provider guide](https://deepline.com/docs/providers/emailbison/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.