JobBoardly API — Overview
This guide explains how to use the JobBoardly API to manage your job board programmatically.
You can use the API to:
Create and manage jobs
Manage memberships and subscriptions
Build custom integrations
Connect external payment systems
Receive candidate application webhooks
Sync data between platforms
API reference:
https://api.jobboardly.com/api-docs
1. Authentication
Before making any requests, you must authenticate using your API credentials.
In the API Docs:
Open api.jobboardly.com/api-docs
Click Authorize
Paste your API token
Click Authorize
Once authorized, all requests made via Try it out will include your credentials automatically.
All requests use Bearer authentication:
Authorization: Bearer YOUR_API_KEY
2. Base URL
All API requests use the following base URL:
https://api.jobboardly.com
3. How the API Works
The API works through HTTP requests.
Your application sends requests to JobBoardly endpoints to:
Create data
Update data
Retrieve data
Trigger actions
Responses are returned in JSON format.
4. Jobs Endpoints
The Jobs endpoints allow you to:
List jobs
Create jobs
Update jobs
Publish or unpublish jobs
Delete jobs
Run bulk actions
These endpoints are commonly used for:
External job syncs
ATS integrations
Custom dashboards
Automated workflows
5. Membership Subscriptions
The API can also be used to manage memberships and subscriptions programmatically.
Common use cases:
External checkout systems
Alternative payment providers
Subscription automation
Membership syncing
🚨 Important:
Recurring billing and payment handling must be managed externally.
The API manages membership access only.
6. Candidate Webhooks
JobBoardly supports candidate application webhooks.
Webhooks send real-time application data to your server whenever a candidate applies for a job.
This can be used to:
Sync candidates externally
Trigger automations
Store applications in your own systems
7. RSS vs XML vs API
Feature | Best For |
RSS Feed | Content syndication |
XML Feed | Job imports |
API | Custom integrations |
Webhooks | Real-time events |
8. Best Practices
Test endpoints using Try it out first
Handle error responses properly
Keep API keys private
Use draft jobs before publishing
Use bulk endpoints for large imports
Avoid exposing API keys in frontend applications
9. Common Response Codes
Code | Meaning |
200 | Successful request |
401 | Unauthorized |
404 | Resource not found |
422 | Validation error |
500 | Server error |