API & Integrations

FindingPotential fits inside the tools you already use.

Our REST API lets you automate candidate invites, pull FIT Scores directly into your ATS or dashboard, and trigger assessments from your existing workflows — without anyone logging into a separate platform.

POST /v1/candidates/invite
POST /v1/candidates/invite
Authorization: Bearer {api_key}
Content-Type: application/json
{
"email": "candidate@example.com",
"role_profile_id": "rp_sales_exec_uk",
"assessments": ["match", "ability"],
"webhook_url": "https://your-ats.com/hooks/fp"
}
✓ 200 OK — Invite sent. Webhook fires on completion.
Capabilities

What the API lets you do

Four core operations cover most integration needs out of the box.

Invite candidates

Trigger assessment invites programmatically — pass a candidate's email, the role profile, and which assessments to run. No manual steps required.

Pull results

Retrieve FIT Scores, profile summaries, and sub-scores for any candidate. Surface the data inside your ATS, hiring dashboard, or reporting tool of choice.

Receive webhooks

Get notified the moment a candidate completes an assessment. Webhook payloads include scores and metadata, so your systems update in real time without polling.

Manage role profiles

Create and update role profiles via API — useful for organisations running multiple job families at volume, or syncing profiles from an existing job architecture.

Where it connects

The systems teams connect most often

Applicant Tracking Systems

Trigger invites automatically when a candidate reaches a certain stage. FIT Scores and profile summaries write back into the candidate record — no copy-pasting, no switching tabs. Works with any ATS that supports outbound webhooks or custom fields.

HRIS Platforms

Use a new hire's start date as an automatic trigger for the New Hire Questionnaire — no manual chasing. Assessment data sits alongside the employee record, making it available for workforce analytics and retention reporting.

Dashboards & BI Tools

Pull assessment data into Power BI, Tableau, Looker, or a custom internal dashboard. Track score distributions by role, location, or hiring manager over time — useful for quality-of-hire and hiring consistency reporting.

Custom Builds

If you have an internal talent platform, recruitment portal, or custom tooling, the API gives you full programmatic control. We provide a sandbox environment and technical documentation to speed up your build.

Getting connected

Up and running in three steps

1

We issue your API credentials

Once API access is agreed, we issue a set of OAuth 2.0 credentials scoped to your account. We'll also set up a sandbox environment so your developers can test against real data structures without touching live candidates.

2

Your team builds the connection

Using the REST API documentation, your developers wire up the endpoints you need. We're available throughout for technical questions and to review your integration before it goes live.

Assessment data flows automatically

Once live, invites fire, scores return, and webhooks notify your systems — without anyone touching FindingPotential directly. Your team works entirely inside the tools they already use.

Technical spec

Built on straightforward, modern standards

No proprietary protocols. No unusual dependencies. Just a clean REST API your developers will recognise immediately.

Protocol
REST / JSON
HTTPS only. JSON request and response bodies. Standard HTTP status codes throughout.
Authentication
OAuth 2.0
Client credentials flow. Short-lived access tokens with configurable scope per integration.
Events
Webhooks
Signed payloads delivered to your endpoint on assessment completion, reminder events, and status changes.
Testing
Sandbox
Full sandbox environment with simulated candidates and responses. Build and test without touching live data.

API access is available as a paid add-on

The FindingPotential platform subscription covers unlimited assessment use for your organisation. API access, which enables programmatic integration with external systems, is priced separately based on the scope of your integration.

Pricing is structured around connection type and the number of systems you're integrating with. Most integrations are a straightforward annual add-on to your existing subscription. Contact us to discuss your setup and get a quote.

Get started

Ready to connect FindingPotential to your stack?

Talk to us about your integration. We'll confirm whether it's straightforward or whether it needs scoping, and give you a realistic quote and timeline.