The Jobvito API

GET /boards/{slug}/jobs

A board's published jobs. No key. No key. Answers on jobvito.com and on the board's own domain, with Access-Control-Allow-Origin: * and a five-minute cache. A board that is not live, or has opted out of search engines, answers 404.

• slug (path, required): The board's slug, as in jobvito.com/b/{slug}.
• q (query): A word in the title.
• location (query): A word in the location.
• category (query): One or more names, comma-separated.
• type (query): One or more of full_time, part_time, contract, temporary, internship, fixed_term, apprenticeship, comma-separated.
• location_type (query): One or more of onsite, hybrid, remote, comma-separated.
• sort (query): one of newest, salary
• page (query): From 1.
• limit (query): 1 to 50; 20 unless said.

Answers 200 with {data: [PublicJob], meta: {total, page, limit, total_pages}}.

curl https://jobvito.com/api/v1/boards/your-board/jobs

GET /board

The board the key opens. Needs a key that can read.

Answers 200 with {data: Board}.

curl https://jobvito.com/api/v1/board \
  -H "Authorization: Bearer jv_live_…"

GET /jobs

The board's jobs, in any state. Needs a key that can read.

• status (query): one of draft, pending, published, expired, archived, rejected
• q (query): A word in the title.
• category (query)
• company_id (query)
• updated_since (query)
• cursor (query): From the previous answer's next_cursor.
• limit (query): 1 to 100; 50 unless said.

Answers 200 with {data: [Job], next_cursor}.

curl https://jobvito.com/api/v1/jobs \
  -H "Authorization: Bearer jv_live_…"

POST /jobs

Make a job. Needs a key that can write. A draft unless status says pending or published. Title is the one field a job needs.

Answers 201 with {data: Job}.

curl https://jobvito.com/api/v1/jobs \
  -X POST \
  -H "Authorization: Bearer jv_live_…" \
  -H "Content-Type: application/json" \
  -d '{"title": "Staff Nurse", "category": "Nursing", "company_name": "Leeds Teaching Hospitals", "salary_min": 30000, "salary_period": "year", "apply_url": "https://example.org/apply"}'

GET /jobs/{id}

One job. Needs a key that can read.

• id (path, required)

Answers 200 with {data: Job}.

curl https://jobvito.com/api/v1/jobs/{id} \
  -H "Authorization: Bearer jv_live_…"

PATCH /jobs/{id}

Change a job's fields. Needs a key that can write. Only the fields sent change. A null clears a field. Status is not a field here: use the actions.

• id (path, required)

Answers 200 with {data: Job}.

curl https://jobvito.com/api/v1/jobs/{id} \
  -X PATCH \
  -H "Authorization: Bearer jv_live_…" \
  -H "Content-Type: application/json" \
  -d '{"title": "Staff Nurse", "category": "Nursing", "company_name": "Leeds Teaching Hospitals", "salary_min": 30000, "salary_period": "year", "apply_url": "https://example.org/apply"}'

DELETE /jobs/{id}

Delete a job. Needs a key that can write. Its applications go with it, as when the owner deletes it.

• id (path, required)

Answers 200 with {data: {id, deleted: true}}.

curl https://jobvito.com/api/v1/jobs/{id} \
  -X DELETE \
  -H "Authorization: Bearer jv_live_…"

POST /jobs/{id}/{action}

Publish, archive, or set a job back to draft or pending. Needs a key that can write. Publishing stamps published_at the first time and clears the review flag, as the owner's Publish does. The same status again changes nothing.

• id (path, required)
• action (path, required): one of publish, draft, archive, pending

Answers 200 with {data: Job}.

curl https://jobvito.com/api/v1/jobs/{id}/publish \
  -X POST \
  -H "Authorization: Bearer jv_live_…"

GET /companies

The board's companies. Needs a key that can read.

• q (query): A word in the name.
• cursor (query): From the previous answer's next_cursor.
• limit (query): 1 to 100; 50 unless said.

Answers 200 with {data: [Company], next_cursor}.

curl https://jobvito.com/api/v1/companies \
  -H "Authorization: Bearer jv_live_…"

POST /companies

Make a company. Needs a key that can write.

Answers 201 with {data: Company}.

curl https://jobvito.com/api/v1/companies \
  -X POST \
  -H "Authorization: Bearer jv_live_…" \
  -H "Content-Type: application/json" \
  -d '{"name": "Bakehouse Nine", "website": "https://bakehousenine.example"}'

GET /companies/{id}

One company. Needs a key that can read.

• id (path, required)

Answers 200 with {data: Company}.

curl https://jobvito.com/api/v1/companies/{id} \
  -H "Authorization: Bearer jv_live_…"

PATCH /companies/{id}

Change a company's fields. Needs a key that can write.

• id (path, required)

Answers 200 with {data: Company}.

curl https://jobvito.com/api/v1/companies/{id} \
  -X PATCH \
  -H "Authorization: Bearer jv_live_…" \
  -H "Content-Type: application/json" \
  -d '{"name": "Bakehouse Nine", "website": "https://bakehousenine.example"}'

GET /categories

The board's categories, in order. Needs a key that can read.

Answers 200 with {data: {categories: [string]}}.

curl https://jobvito.com/api/v1/categories \
  -H "Authorization: Bearer jv_live_…"

POST /categories

Add a category. Needs a key that can write.

Answers 201 with {data: {categories: [string]}}.

curl https://jobvito.com/api/v1/categories \
  -X POST \
  -H "Authorization: Bearer jv_live_…" \
  -H "Content-Type: application/json" \
  -d '{"name": "Pharmacy"}'

PUT /categories

Put the categories in a new order. Needs a key that can write. The same names, each once.

Answers 200 with {data: {categories: [string]}}.

curl https://jobvito.com/api/v1/categories \
  -X PUT \
  -H "Authorization: Bearer jv_live_…" \
  -H "Content-Type: application/json" \
  -d '{"categories": ["Nursing", "Midwifery", "Pharmacy"]}'

PATCH /categories/{name}

Rename a category. Needs a key that can write. Every job, subscription and page that held the old name takes the new one, and the old address redirects.

• name (path, required)

Answers 200 with {data: {categories: [string]}}.

curl https://jobvito.com/api/v1/categories/Nursing \
  -X PATCH \
  -H "Authorization: Bearer jv_live_…" \
  -H "Content-Type: application/json" \
  -d '{"name": "Pharmacy"}'

DELETE /categories/{name}

Remove a category. Needs a key that can write.

• name (path, required)
• move_to (query): Another of the board's categories to move its jobs into first. Without it the jobs are left with none.

Answers 200 with {data: {categories: [string]}}.

curl https://jobvito.com/api/v1/categories/Nursing \
  -X DELETE \
  -H "Authorization: Bearer jv_live_…"