Job Board API
A REST API to create, update, publish, and sync job listings on your board programmatically.
Get started →Job Boardly includes a full REST Job Board API so you can manage your board programmatically instead of through the dashboard. Create, update, and publish job listings, read your jobs and categories into another app, sync postings from an external system, and receive signed webhooks when candidates apply — all over standard HTTP with JSON.
The API is available on the Pro plan. The complete reference (every endpoint, parameter, and webhook) lives in your dashboard at app.jobboardly.com/api-docs; this page is a quick overview to get you started.
What you can do with it
- Manage jobs — create, update, publish/unpublish, expire, and delete listings, individually or in bulk
- Read your data — pull live jobs, categories, employment types, and counts into another site or app
- Sync from anywhere — push roles from your ATS, spreadsheet, or internal tooling onto your board
- React in real time — receive signed webhooks when a candidate applies or registers (Pro boards)
Authentication
Authenticate with a bearer token. Create an API key in your dashboard under Settings → Board → API access — keys are board-scoped and can be rotated at any time — and send it in the Authorization header on every request:
Authorization: Bearer YOUR_API_KEY
Keep your API key server-side. It’s a board-scoped secret — never embed it in frontend or browser code, mobile apps, or a public repository. Store and use it only on a trusted server. You can rotate the key anytime from Settings → Board → API access (rotating immediately invalidates the old one), and you should revoke and rotate right away if a key is ever exposed.
The API is served from your board’s api subdomain, versioned under /v1 — for example https://api.yourboard.com/v1.
Quickstart
List your current jobs:
curl https://api.yourboard.com/v1/jobs \
-H "Authorization: Bearer YOUR_API_KEY"
{
"jobs": [
{
"id": 8472,
"title": "Senior Drone Pilot",
"company_name": "SkyOps",
"location_type": "remote",
"office_location": null,
"categories": ["Operations"],
"state": "published",
"url": "https://yourboard.com/jobs/senior-drone-pilot",
"created_at": "2026-05-28T14:03:00Z"
}
],
"meta": { "current_page": 1, "per_page": 50, "total_pages": 1, "total_count": 1 },
"links": { "self": "...", "next": null, "prev": null }
}
Create a job — title, company_name, and application_link are required:
curl -X POST https://api.yourboard.com/v1/jobs \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Senior Drone Pilot",
"company_name": "SkyOps",
"application_link": "https://skyops.example/careers/123",
"description": "<p>We are hiring a senior drone pilot…</p>",
"location": "remote",
"category_ids": [1, 2]
}'
Field note: create requests use
location(one ofremote,onsite,hybrid); job responses return the equivalentlocation_typeplus an optionaloffice_location. Likewise, sendcategory_ids(integer IDs) when writing — responses returncategoriesby name.
Core endpoints
| Method | Endpoint | Description |
|---|---|---|
GET |
/v1/jobs |
List jobs (full-text search, filter by state/source, paginated) |
POST |
/v1/jobs |
Create a job |
GET |
/v1/jobs/{id} |
Retrieve a single job |
PATCH |
/v1/jobs/{id} |
Update a job (send only the fields you’re changing) |
DELETE |
/v1/jobs/{id} |
Delete a job |
POST |
/v1/jobs/{id}/publish |
Publish a job (also /unpublish) |
GET |
/v1/categories |
List your board’s categories |
GET |
/v1/arrangements |
List employment types (e.g. fulltime, internship) |
Plus bulk job actions, job counts, a Blog Posts API, and monetization/entitlement endpoints — see the full API reference for every endpoint, parameter, and error code.
Webhooks
On Pro boards, Job Boardly sends signed webhooks (HMAC-SHA256 over the raw body) to your endpoint when a candidate submits an application or registers — so you can push applicants straight into your CRM, Slack, or automation tooling. Configure the URL and signing secret under Settings → Board → Integrations → Webhooks.
Pagination & availability
List endpoints are paginated with page and per (up to 50 per page) and return meta and links objects for navigation. The Job Board API is available on the Pro plan.
Frequently asked questions
Is the API REST or GraphQL? It’s a standard REST API — HTTPS requests with JSON request and response bodies, authenticated with a bearer token.
Do I need to be a developer to use it? No. Most of Job Boardly is no-code, and the API is optional — but if you (or your developer) want to automate job management or wire your board into another system, the REST endpoints and signed webhooks are there.
Which plan includes the API? The Job Board API is available on the Pro plan. See pricing for details.
Start using Job Board API today
Everything you need is included in your Job Boardly subscription. No extra plugins, no configuration.