# API docs

Our API is designed to be integrated in minutes:

- Simple and clear `JSON` responses
- Consistent response envelope across all endpoints
- API key authentication with a single header
- Credit-based pricing - you only pay for revealed data
- Machine-readable [OpenAPI specification](https://getprospect.com/api-docs/openapi.json), plus a
  markdown twin of every docs page (append `.md` to its URL)

## Get started

- [Authentication](https://getprospect.com/api-docs/authentication.md) - authenticate your requests and understand the request format
- [Credits and rate limits](https://getprospect.com/api-docs/credits-and-limits.md) - understand how credits are spent
- [Pagination](https://getprospect.com/api-docs/pagination.md) - page through search results
- [Errors](https://getprospect.com/api-docs/errors.md) - error envelope and status codes
- [Integration best practices](https://getprospect.com/api-docs/integration-best-practices.md) - retries,
  credit control, bulk endpoints and pacing for automated integrations

## Search endpoints

- [People Search](https://getprospect.com/api-docs/people-search.md) - search the people index with structured filters
- [Company Search](https://getprospect.com/api-docs/company-search.md) - search the companies index

## Enrich endpoints

- [People Enrich](https://getprospect.com/api-docs/people-enrich.md) - enrich a person with full profile data
- [People Bulk Enrich](https://getprospect.com/api-docs/people-bulk-enrich.md) - enrich up to 50 people per request
- [Company Enrich](https://getprospect.com/api-docs/company-enrich.md) - enrich a company with full profile data
- [Company Bulk Enrich](https://getprospect.com/api-docs/company-bulk-enrich.md) - enrich up to 50 companies per request
- [Email Finder](https://getprospect.com/api-docs/email-finder.md) - find a work email by name and company
- [Email Verifier](https://getprospect.com/api-docs/email-verifier.md) - verify the deliverability of an email

## Saved records

- [Get Person](https://getprospect.com/api-docs/people-get.md) and [Get Company](https://getprospect.com/api-docs/company-get.md) - read one record by id, with your workspace's saved state
- [Save People](https://getprospect.com/api-docs/people-save.md) - save up to 500 people into your lists
- [Preview Save Credits](https://getprospect.com/api-docs/people-calculate-credits.md) - price a save before you run it, free
- [Save Companies](https://getprospect.com/api-docs/company-save.md) - save companies, optionally into company lists

## Blocklist

- [People](https://getprospect.com/api-docs/blocklist-people-list.md) and [companies](https://getprospect.com/api-docs/blocklist-companies-list.md) your workspace never wants to see in search, enrich or email find: list, block and unblock

## Jobs and account

- [Get Job](https://getprospect.com/api-docs/jobs-get.md) - poll any async job by id
- [Get Current User](https://getprospect.com/api-docs/me.md) - who a credential belongs to and the workspace it acts in
- [Get Credit Balances](https://getprospect.com/api-docs/credits.md) - the live balance of each credit type

## Events

- [Stream Events](https://getprospect.com/api-docs/events-stream.md) - a realtime stream of your workspace's notifications and credit, subscription and integration changes

## Webhooks

- [Create Webhook](https://getprospect.com/api-docs/webhooks-create.md) - get a signed POST at your URL when a person or company is saved or an email is found, with the event types, the signature check and the retry schedule
- [List](https://getprospect.com/api-docs/webhooks-list.md), [get](https://getprospect.com/api-docs/webhooks-get.md), [update](https://getprospect.com/api-docs/webhooks-update.md) and [delete](https://getprospect.com/api-docs/webhooks-delete.md) webhooks, [send a test event](https://getprospect.com/api-docs/webhooks-test.md) and [list deliveries](https://getprospect.com/api-docs/webhooks-deliveries.md)

## Object schemas

- [Person object](https://getprospect.com/api-docs/person-object.md) and [Company object](https://getprospect.com/api-docs/company-object.md) - the shapes returned by the search, enrich and get endpoints