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

# Get started with a personal API key

> Create a personal key, check it, and make your first Recruiter API calls.

A personal API key calls the Paraform API **as you**, with the same access you have in the app. Use it to work with your Paraform data, such as roles, candidates, and call transcripts, from your own tools and scripts.

<Note>
  The **API keys** tab only appears for accounts that have access. If you don't see it, ask your Paraform contact.
</Note>

<Steps>
  <Step title="Create a key">
    Open the **API keys** tab of your account settings (`/manage/api-keys`) and create a key. Give it a name and choose its scopes:

    | Scope | Lets the key |
    | - | - |
    | `roles:read` | Browse roles, read full role briefs, and read your saved preferences |
    | `candidates:read` | Read your CRM candidates and your Parascribe calls |
    | `identity:read` | Call `GET /identity` |

    Recommendations need both `candidates:read` and `roles:read`.

    The full key is shown **once**. Copy it into a secrets manager or environment variable straight away.
  </Step>

  <Step title="Check it works">
    ```bash theme={null}
    export PARAFORM_API_KEY="pf_live_…"

    curl "https://external-api.paraform.com/api/external/v1/identity" \
      -H "Authorization: Bearer $PARAFORM_API_KEY"
    ```

    The response has `principal: "recruiter"`, your `userId`, `name`, `email`, and the key's effective `scopes`. Personal keys can't hold agency scopes, so agency-only endpoints, such as the Talent Network endpoints, answer `403` for a personal key.
  </Step>

  <Step title="Make your first call">
    List the roles you're working on:

    ```bash theme={null}
    curl "https://external-api.paraform.com/api/external/v1/recruiter/roles?primaryOnly=true" \
      -H "Authorization: Bearer $PARAFORM_API_KEY"
    ```

    Then continue with [Browse roles and read a brief](/recruiter/guides/browse-roles).
  </Step>
</Steps>

## What a personal key can see

* **Only your own data.** Candidates, recommendations, and Parascribe calls are always yours. There's no parameter for reading another recruiter's data, even if you're an agency owner who can see more in the app.
* **Exactly what you see in the app.** Roles, fees, and slots reflect your own approvals. If your agency hides payment from members, `fee` amounts are `null`.

## Managing keys

* You can hold up to 5 active personal keys. Revoke unused ones on the **API keys** tab.
* You can give a key an expiry date when you create it.
* Only you can see or revoke your personal keys. Agency owners can't.
* A key stops working (`401`) if it's revoked, expires, or your account can no longer recruit on Paraform.

Rate limits, errors, and pagination work the same as for every key. See [Rate limits](/rate-limits), [Errors](/errors), and [Pagination](/pagination).


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