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

Agency API

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.

Recruiter API

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.

​
Which key do I need?

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

​
Quick start

1

Create a key

Create an agency or personal key in the Paraform app (see Authentication). The full key is shown only once, when you create it.
2

Check connectivity

Call GET /identity. It returns who your key acts as and the scopes it carries.
3

Follow a guide

Agencies usually start with Submit candidates. Recruiters usually start with Browse roles.

​
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.
GET /docs describes every endpoint for every caller. The reference tabs on this site show only the endpoints each key type can call.