Skip to main content
An agency API key calls the Paraform API as your agency’s integration, not as any one person. Use it to connect your CRM or internal tools to your agency’s Talent Network and roles.
Only agency owners can generate agency API keys. If you’re an agency member, ask an owner of your agency to create one for you.
Paraform enables API access per agency. If you’re an owner and don’t see the API Keys tab, ask your Paraform contact.
1

Generate a key

Open the API Keys tab of your agency settings (/agency/api-keys) and create a key. Give it a name and choose its scopes:The talent_network:* scopes are offered only when your agency has Talent Network access.The full key is shown once. Copy it into a secrets manager or environment variable straight away. Only use it from your servers, never from browser or mobile code.
2

Check it works

The response has principal: "agency", your agencyId, the key’s name, and its effective scopes. Any valid key can call GET /identity, whatever scopes it holds.
3

Make your first call

List the candidates your agency has in the talent network:
Then continue with Submit candidates, Check network membership, or Read agency roles.

​
What an agency key can see

  • Only your own agency’s data. Talent Network endpoints return your agency’s candidates only. A candidate in the network through a different agency looks the same as someone who isn’t in the network.
  • Roles through a member. Agency role endpoints read roles as one of your approved members sees them. You choose the member with recruiterEmail on each call. See Read agency roles.

​
Managing keys

  • Your agency can hold up to 50 active keys. Revoke unused ones on the API Keys tab.
  • You can give a key an expiry date when you create it.
  • A key stops working (401) if it’s revoked or expires.
  • Agency keys are separate from personal API keys. Personal keys can’t call agency endpoints.
Rate limits, errors, and pagination work the same as for every key. See Rate limits, Errors, and Pagination.