External Jobs API

Submit one or more job openings from another app. Jobs enter pending review and go live only after admin approval. Request an API key from your FlareBox admin (Admin → Companies → Job Openings → API Keys).

Endpoint

POST /api/integrations/jobs

Authentication

Send your assigned key in the x-api-key header. Keys look like flare_… and are shown only once when created.

x-api-key: flare_your_secret_key_here

Rate limits

60 POST requests per minute per API key. Batch status polling: 120 GET requests per minute.

Request JSON

{
  "jobs": [
    {
      "title": "Frontend Developer",
      "companyName": "Acme Labs",
      "location": "Pune, India",
      "description": "Build and maintain modern web interfaces.",
      "category": "with_link",
      "application_link": "https://acmelabs.example/jobs/frontend-developer",
      "type": "full-time",
      "experience": "mid",
      "expiry_date": "2026-12-31",
      "companyWebsite": "https://acmelabs.example",
      "companyCity": "Pune",
      "companyIndustry": "Software"
    }
  ]
}

You may also POST a single job object without wrapping it in jobs.

Field reference

FieldRequiredNotes
titleYes2–180 chars
companyNameYesMust exist or provide company city/country/website to auto-create
locationYes2–180 chars
descriptionYes10–5000 chars
categoryNowith_link (needs application_link) or cold_email (needs email). Default: cold_email
typeNofull-time, part-time, contract, internship
experienceNoentry, mid, senior, executive

Response

{
  "batchId": "external-job-1710000000000",
  "accepted": 1,
  "failed": 0,
  "results": [
    { "rowNumber": 1, "status": "pending_review", "jobId": "..." }
  ]
}

Poll batch status

GET /api/integrations/jobs/batches/{batchId}
x-api-key: flare_your_secret_key_here

Returns per-job status (pending, active, rejected) for batches submitted with the same API key.

cURL example

curl -X POST "https://your-domain.com/api/integrations/jobs" \
  -H "Content-Type: application/json" \
  -H "x-api-key: flare_your_secret_key_here" \
  -d '{"jobs":[{"title":"Frontend Developer","companyName":"Acme Labs","location":"Pune, India","description":"Build and maintain modern web interfaces.","category":"cold_email","email":"careers@acmelabs.example","companyWebsite":"https://acmelabs.example","companyCity":"Pune"}]}'

JavaScript example

const res = await fetch("https://your-domain.com/api/integrations/jobs", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": process.env.FLAREBOX_JOBS_API_KEY,
  },
  body: JSON.stringify({
    jobs: [{
      title: "Frontend Developer",
      companyName: "Acme Labs",
      location: "Pune, India",
      description: "Build and maintain modern web interfaces.",
      category: "cold_email",
      email: "careers@acmelabs.example",
      companyWebsite: "https://acmelabs.example",
      companyCity: "Pune",
    }],
  }),
});
const data = await res.json();
// Poll: GET /api/integrations/jobs/batches/${data.batchId}