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

# Use Forager in Deepline

> Use totals endpoints first (free) to estimate volume, then run role/company/job and detail lookups. Strong for verified mobile contacts.

[Human guide: work with your agent →](https://deepline.com/docs/human/providers/forager/guide.md)
Inspect one Forager action before starting provider-backed work. Your first result is a verified input and output contract.

## Provider-specific requirements

Forager has 850M+ B2B person records and is especially strong for verified mobile phone numbers (200M+ database). Prefer Forager over other providers when the goal is phone number discovery.

### Search & Discovery

* Always start with totals operations (`forager_person_role_search_totals`, `forager_organization_search_totals`, `forager_job_search_totals`) to estimate result volume at zero credit cost before running paid searches.
* Use `forager_person_role_search` for prospecting by role, skills, and company criteria. Search is billed per page, so keep pages bounded while exploring.
* Use `forager_organization_search` for company prospecting by industry, size, technology stack, and revenue filters.
* Use `forager_job_search` for intent-signal analysis: companies hiring for specific roles indicate growth and budget in those areas.

### Boolean Text Search

* Fields like `role_title`, `role_description`, `person_name`, `organization_description` use boolean text search.
* **Multi-word phrases MUST be quoted**: `'"VP Sales"'` not `'VP Sales'`. Unquoted phrases cause a parse error.
* Supports AND, OR, NOT, and parentheses: `("VP Sales" OR "Director of Sales") NOT intern`

### Filter Fields Use Integer IDs

* `person_locations`, `person_skills`, `person_industries`, `organization_locations`, etc. all require **integer IDs**, not name strings.
* Retrieve IDs from the lookup operations first (e.g. `forager_industries`, `forager_locations`, `forager_person_skills`).

### Enrichment & Reveals

Use `forager_person_detail_lookup` to enrich a known person by `person_id` or `linkedin_public_identifier`.
Use `forager_person_detail_reverse_lookup_by_email` when you already know a work/personal email and want to resolve the person.

* Use `forager_person_detail_reverse_lookup_by_phone_number` when you already know a phone number and want to resolve the person.
* Use `forager_website_detail_lookup` for technographic enrichment on a specific domain.
* API docs: [https://docs.forager.ai/openapi/api\_keys](https://docs.forager.ai/openapi/api_keys)

### Cross-Provider Workflow Tips

* When building name-dependent workflows (e.g. email pattern generation), start from a source that returns full names before using Forager for phone/email reveals.
* Forager person search results include `person_id` -- save this for subsequent `forager_person_detail_lookup` calls to avoid re-searching.
* Check account balance from Forager before large batch operations.

## Find an applicable action

Confirm your effective workspace, then search the live catalog:

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline auth status --json
deepline search "Forager" --type tools --json
```

Search returns candidates. Check the returned provider and operation rather than selecting a similar title automatically.

## Inspect the selected contract

Replace `<returned-tool-id>` with the identifier returned by discovery:

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline describe <returned-tool-id> --json
```

These commands do not execute the selected provider action. Read its required inputs, supported access mode, pricing unit, outputs, and limits.

A connection does not establish that every action supports BYOK. Follow the provider-specific requirements above and the live action contract.

## Prepare one reviewed input

Use one authorized record that matches the inspected schema. Preserve its source identity and define the result you will accept.

Open the action reference for its payload and response shape. Provider-backed execution can incur usage or external effects.

For reusable logic, follow [Write Plays](https://deepline.com/docs/sdk-v2/plays.md). For direct-call recovery, use [Tool execution recovery](https://deepline.com/docs/sdk-v2/tool-execution-recovery.md).

> [!TIP]
>
> Continue only when the workspace, provider, required fields, acceptance rule, and applicable price are understood. Keep unavailable access separate from no-result evidence.


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