Skip to main content
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.
The API keys tab only appears for accounts that have access. If you don’t see it, ask your Paraform contact.
1

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: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.
2

Check it works

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

Make your first call

List the roles you’re working on:
Then continue with Browse roles and read a brief.

​
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, Errors, and Pagination.