TAP Recruiter
Integration partner guide · API v1

Test the connection.
Know what goes live.

Use an approved partner account and a tap_test_ key. All records stay in a separate test database.

Open your test workspaceDownload test OpenAPI

1. Create a scoped test key

Apply in the partner portal, verify your email and wait for TAP’s review. Once approved, choose permissions and an expiry, then click Create test API key. Copy the key once into your server’s secret storage. Never embed it in a website, mobile app or public repository.

Approval lasts 30 days. Keys last 7 or 30 days, capped by your approval expiry. To request an extension or a different test workflow, contact TAP. The owner can renew or suspend access.

2. Read your sample company and jobs

curl https://taprecruiter.com/developers/sandbox/api/v1/clients \
  -H "Authorization: Bearer $TAP_TEST_KEY"

curl https://taprecruiter.com/developers/sandbox/api/v1/jobs \
  -H "Authorization: Bearer $TAP_TEST_KEY"

The company response supplies the clientId for your jobs. Employer testing returns the employer’s own company. Agency testing returns the agency’s sample client. Requests must come from your server; browser-origin requests are rejected.

3. Create a private sample job

curl -X POST https://taprecruiter.com/developers/sandbox/api/v1/jobs \
  -H "Authorization: Bearer $TAP_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: sample-job-create-0001" \
  -d '{"title":"Sample Operations Manager","clientId":"YOUR_SAMPLE_COMPANY_ID",
       "location":"Melbourne","type":"Permanent","salary":120000,
       "currency":"AUD","taxTreatment":"no-tax","feeModel":"Fixed fee",
       "feeValue":0,"description":"Sample job for integration testing."}'

Reuse the same idempotency key and body after a timeout. A replay returns the existing job rather than creating a duplicate. Changed input with the same key returns 409.

4. Read, update and handle failures

Read GET /jobs/{id} and retain its ETag. Send it as If-Match when you PATCH /jobs/{id}. Only title, location and description can be changed. A stale revision returns 409; read again before deciding whether to retry. GET /jobs/{id}/progress returns stage counts, not candidate details.

Resetting sample data revokes all your test keys and replaces the sample workspace. It does not extend approval. Up to 3 active keys, 10 newly created keys per day, 100 jobs, 60 requests per minute and 1,000 requests per day per partner. A shared 20,000-request daily allowance protects the test service.

Before a customer connects

Live keys are created by an authorised administrator on Agency Growth or Employer Workspace. Partner approval does not bypass their plan or permissions. This release does not provide OAuth installation, cross-customer access, candidates, CVs, client creation, deletion, billing, messages, webhooks or automatic two-way sync.

Read the customer API specification →