Your job board API

The API allows to integrate your job board with other services, automate tasks and create custom workflows.

It is accessible on your job board address and accepts JSON or form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP verbs, response codes and authentication.

Method Endpoint Description Authorization  
GET
/jobs.json The list of all active jobs
None
GET
/jobs.json?q=keyword Search the jobs by the given keyword
None
GET
/jobs.json?term=term_id Filter the jobs by the given term ID
None
GET
/jobs.json?category=category_id Filter the jobs by the given category ID
None
GET
/jobs/:id.json The details of a job with the given ID
None
POST
/jobs.json Create a new job
User
PUT
/jobs/:id.json Update a job with the given ID
User
DELETE
/jobs/:id.json Delete a job with the given ID
User
GET
/categories.json The list of all categories
User
POST
/categories.json Create a new category
Admin
PUT
/categories/:id.json Update a category with the given ID
Admin
DELETE
/categories/:id.json Delete a category with the given ID and all related jobs ⚠️
Admin
GET
/terms.json The list of all terms
User
POST
/terms.json Create a new term
Admin
PUT
/terms/:id.json Update a term with the given ID
Admin
DELETE
/terms/:id.json Delete a term with the given ID and all related jobs ⚠️
Admin
GET
/plans.json The list of all active plans
User
POST
/plans.json Create a new plan
Admin
PUT
/plans/:id.json Update a plan with the given ID
Admin
PUT
/plans/:id/archive.json Archive a plan with the given ID
Admin
GET
/analytics.json The analytics data for the board
Admin
GET
/subscribers.json The list of all email subsribers
Admin
GET
/users.json The list of all registered users
Admin
  • Administrators can read, create, update and delete any resource on the board.
  • Some resources will return extra data when authenticated as administrator or the owner of that resource.
  • If your integration does not need administrator access, it's a good idea to create a separate user on your board to authenticate the API requests.
  • Please keep your email and password secure! Change them if you think someone else has access to them.