REST API

API Documentation

Integrate with the WHV Platform programmatically. Access jobs, employers, candidates, and pods through our RESTful API.

Authentication

Bearer Token Auth

All API requests require a valid API key passed as a Bearer token in the Authorization header.

Generate your API key from the Partner Portal settings page. Keep your key secret and never expose it in client-side code.

Pass key via Authorization: Bearer <key>
All requests must use HTTPS
Keys are scoped to your organisation

headers

// Include in every request
const headers = {
  'Authorization': 'Bearer your_api_key',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
};

API Endpoints

Six resource categories covering every aspect of the WHV Platform.

Jobs

Search, filter, and post job listings. Access location data, salary ranges, and visa-compatible positions.

GET /api/jobsPOST /api/jobsGET /api/jobs/:id

Employers

Access employer profiles, workplace details, ratings, and industry information.

GET /api/employersGET /api/employers/:idGET /api/employers/:id/jobs

Candidates

Browse candidate profiles, skills, availability, and match candidates to open positions.

GET /api/candidatesGET /api/candidates/:idGET /api/candidates/match

Pods

Discover travel pods, manage group membership, and access group dynamics data.

GET /api/podsGET /api/pods/:idGET /api/pods/:id/members

Applications

Track application status, manage submissions, and review candidate responses.

GET /api/applicationsPOST /api/applicationsPATCH /api/applications/:id

Compliance

Verify visa compliance, check work-hour limits, and validate employer obligations.

GET /api/complianceGET /api/compliance/checkGET /api/compliance/visa/:id

Quick Start

Up and Running in Minutes

Fetch job listings with a single API call. All responses are returned as JSON with consistent pagination and error handling.

1Generate an API key from Partner Portal settings
2Include your key in the Authorization header
3Make requests to any endpoint and parse JSON responses

fetch-jobs.js

// Fetch all jobs with pagination
const response = await fetch(
  'https://api.whvplatform.com/v1/jobs',
  {
    headers: {
      'Authorization': 'Bearer your_api_key'
    }
  }
);

const { data, pagination } = await response.json();

// data: Array of job objects
// pagination: { cursor, hasMore, total }
console.log(`Found ${pagination.total} jobs`);

Rate Limits & Pagination

Built for reliability. Consistent patterns across every endpoint.

Rate Limits

1,000

Requests per hour

Rate limit headers are included in every response. Contact us for higher limits on enterprise plans.

Cursor Pagination

Default page size

All list endpoints use cursor-based pagination. Pass the cursor parameter to fetch the next page.

JSON Responses

UTF-8

Content encoding

All responses return application/json with consistent error objects and status codes.

Start Building Today

Get your API key and start integrating with the WHV Platform in minutes.

Get Your API Key Back to Developer Hub