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

# Paraform API

> Connect your tools and recruiting systems to Paraform, with API keys for agencies and for individual recruiters.

The Paraform API is a JSON-over-HTTPS API for two kinds of integration. Each one uses its own type of API key.

<CardGroup cols={2}>
  <Card title="Agency API" icon="building" href="/agency/guides/submit-candidates">
    For agencies connecting a CRM or ATS. Work with your agency's Talent Network and the roles your members can see, from your own systems.
  </Card>

  <Card title="Recruiter API" icon="user" href="/recruiter/guides/personal-api-keys">
    For individual recruiters. A personal key acts as you, so your own tools can work with the same data you use in Paraform, like roles and candidates.
  </Card>
</CardGroup>

## Which key do I need?

| You want to… | Use | Created at |
| - | - | - |
| Connect your agency's CRM or ATS to Paraform, including your Talent Network | An **agency API key** | The **API Keys** tab of your agency settings (`/agency/api-keys`), by an agency owner |
| Use your own Paraform account data in your own tools | A **personal API key** | The **API keys** tab of your account settings (`/manage/api-keys`), by you |

Both key types use the same base URL, authentication header, error format, and rate limits. The [Get started](/authentication) pages apply to both. Each audience's tab lists only the endpoints its key type can call.

## Quick start

<Steps>
  <Step title="Create a key">
    Create an agency or personal key in the Paraform app (see [Authentication](/authentication)). The full key is shown only once, when you create it.
  </Step>

  <Step title="Check connectivity">
    Call `GET /identity`. It returns who your key acts as and the scopes it carries.

    ```bash theme={null}
    curl "https://external-api.paraform.com/api/external/v1/identity" \
      -H "Authorization: Bearer $PARAFORM_API_KEY"
    ```
  </Step>

  <Step title="Follow a guide">
    Agencies usually start with [Submit candidates](/agency/guides/submit-candidates). Recruiters usually start with [Browse roles](/recruiter/guides/browse-roles).
  </Step>
</Steps>

## Machine-readable specification

The API serves its own OpenAPI 3.0 document at `GET /docs`. No API key is needed. It's generated from the same definitions the server uses to route and validate requests, so it always matches the deployed API. Use it to generate a client or look up exact field contracts.

```bash theme={null}
curl "https://external-api.paraform.com/api/external/v1/docs"
```

<Note>
  `GET /docs` describes every endpoint for every caller. The reference tabs on this site show only the endpoints each key type can call.
</Note>


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