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

# API reference

> Base URL, authentication, and a map of every Pipecorn REST endpoint: leads, accounts, waterfall enrichment, signals, searches, personas, lists, and utilities.

The Pipecorn REST API gives you programmatic access to the same data as the
[web app](https://app.pipecorn.com): search and extract leads, enrich
companies and contacts, pull buying signals, and manage Sales Navigator lists.
Every endpoint below is documented with its parameters, an interactive
request builder, and example responses.

|                    |                                                                                                      |
| ------------------ | ---------------------------------------------------------------------------------------------------- |
| **Base URL**       | `https://app.pipecorn.com/api/v2/`                                                                   |
| **Authentication** | `X-API-KEY` header. Get a key from [API keys](https://app.pipecorn.com/settings/apis/keys)           |
| **Format**         | JSON request and response bodies                                                                     |
| **Metering**       | Enrichment spends [credits](/api-reference/credits-vs-limits); extraction counts against plan limits |

## Your first request

Check your credit balance and plan limits. This call is free and confirms your
key works.

```bash theme={null}
curl https://app.pipecorn.com/api/v2/credits \
  -H "X-API-KEY: your_api_key"
```

If the key is wrong you get a `401`. See [Credit and limit errors](/api-reference/errors)
for the `402`, `403`, and `422` responses that metering can return.

## Endpoints

<CardGroup cols={2}>
  <Card title="Leads (People)" icon="users" href="/api-reference/endpoints/leads/advanced_search">
    Search people by title, seniority, location, and industry. Extract leads
    from a company or from Sales Navigator, and enrich a single person.
  </Card>

  <Card title="Accounts (Companies)" icon="building" href="/api-reference/endpoints/accounts/search">
    Search companies by firmographics, enrich a single account, and pull
    headcount by department, tech stack, and open job postings.
  </Card>

  <Card title="Waterfall Enrichment" icon="sparkles" href="/api-reference/endpoints/enrichments/single">
    Find verified business emails and phones through 20+ sources, one contact
    at a time, in batches, or synchronously.
  </Card>

  <Card title="Signals" icon="bolt" href="/api-reference/endpoints/signals/hiring">
    Hiring, growth, lookalike companies, tech-stack search, new hires, job
    changes, and LinkedIn posts, comments, reactions, and engagers.
  </Card>

  <Card title="Searches" icon="magnifying-glass" href="/api-reference/endpoints/searches/index">
    List, inspect, and delete the saved searches your extractions create.
  </Card>

  <Card title="Personas" icon="id-badge" href="/api-reference/endpoints/personas/index">
    Read the personas that define your ideal buyer profiles.
  </Card>

  <Card title="Lists" icon="list" href="/api-reference/endpoints/lists/index">
    Create and update Sales Navigator lists and read their contents.
  </Card>

  <Card title="Miscellaneous" icon="wrench" href="/api-reference/endpoints/miscellaneous/account-credits">
    Credit balance and consumption, account information, location IDs, and
    technology slugs.
  </Card>
</CardGroup>

## Before you build

* [Main use cases](/api-reference/main-use-cases) walks through the three
  flows most integrations start with.
* [Authentication](/essentials/authentification) covers the header format and
  key management.
* [Credits vs limits](/api-reference/credits-vs-limits) explains which
  requests spend credits and which draw on plan quotas.
* Prefer not to write HTTP calls? The [CLI](/cli/overview) and the
  [MCP server](/mcp/overview) wrap this API.