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

# SeekOut Partner API

> Get access to the SeekOut Partner API and choose the endpoints for search, contact data, profile refresh, and usage analytics.

Use the SeekOut Partner API to add talent search and candidate data to custom applications, dashboards, scheduled jobs, and backend integrations. The API uses conventional REST endpoints and returns JSON responses.

## Before you begin

Contact your SeekOut representative to request Partner API access. SeekOut provisions an API key for your organization and configures its permissions and rate limits.

<Warning>
  Keep your API key in a secrets manager and call the Partner API from a trusted server. Do not expose the key in browser or mobile application code.
</Warning>

## Authenticate requests

Send your provisioned key in the `Api-Key` header with every request. The base URL is:

```text theme={null}
https://partnerapi.seekout.io
```

## Choose an endpoint

| Goal                                                             | Sidebar section         |
| ---------------------------------------------------------------- | ----------------------- |
| Start a people search, retrieve results, or match known profiles | **Search and matching** |
| Retrieve premium contact details or check remaining quota        | **Contact data**        |
| Refresh stored profiles and monitor refresh jobs                 | **Profile refresh**     |
| Review API transactions over a time interval                     | **Usage analytics**     |

Each endpoint page documents its parameters, request body, and responses.
