UBIO Recruitment API

# Mining a Job Post

To enable your users to apply for job posts, they must be added to the UBIO database. This process ensures that the job application questions are "mined" from the job post webpage, allowing you to create application forms on your website.

The mining process involves sending an HTTP request to the UBIO API with the URL of the job post from the ATS and your jobPostId, which will be used to reference the job post in future interactions.

The jobPostId will be confirmed in the response, along with the status of the mining job. The status can be either queued or processing.

Submitting another request with the same jobPostId will overwrite the previous results once the mining is complete.

For mining a large number of job posts or integrating with a new employer/ATS, see Mining a Batch of Job Posts.

# API Endpoint

To submit a single job post for mining, use the following API endpoint:

POST /v1/recruitment/job-posts/mine/

# Headers

Name Type Required Description
Authorization string ✅ See Authentication
Content-Type string ✅ Media type of the request. Should be application/json.

# Body Parameters

Parameter Type Required Description
jobPostId string ✅ Unique identifier for the job post reference.
url string ✅ Job post URL from the ATS.
Example: https://careers.employer.com/jobs/EXAMPLE
employer string ✅ Name of the employer/company posting the job.
Example: Company ABC
jobTitle string ✅ The title of the job position.
Example: Software Engineer
country string ISO 3166-1 alpha-2 country code (lowercase) for geofencing. Default is gb.

# Code Sample

POST /v1/recruitment/job-posts/mine

curl -X POST 'https://services.automation.cloud/v1/recruitment/job-posts/mine/' \
    -H 'Authorization: Basic <credentials>' \
    -H 'Content-Type: application/json' \
    -L \
--data '{
  "jobPostId": "example123",
  "url": "https://careers.employer.com/jobs/EXAMPLE",
  "category": "test",
  "employer": "Company ABC",
  "jobTitle": "Software Engineer",
  "country": "gb"
}'

# Success Responses

If the request is successful, the API returns a 200 OK status with a response like this:

{
    "status": "queued",
    "jobPostId": "example123"
}

☝️ The jobPostId and status of the related mining job are confirmed in the response.

# Error Handling

  • 401 Unauthorized – Invalid or missing API key.
  • 500 Internal Server Error – UBIO system error, try again later.

← Mining a Batch of Job Posts →