Sign in

v1

latestOpenAPI 3.0.02026-08-061280285.2 KB
Job APIs

The jobs endpoint allows you to export all jobs-related information from Recruiterflow.

<br/><b>Please find the output format of different engagement types below.</b><br><br/><b>Engagement Type : Contingent</b><br/> <h4>Expected Salary</h4><br/> <li> expected_salary: {<br/> currency: "USD",<br/> number: 700000<br/> }<br/> </li><br/><br/> <h4>Expected Fee</h4><br/> <li> expected_fee : {<br/> currency: "USD",<br/> number: 35000<br/> }<br/> </li><br/><br/> <h4>Job Type</h4><br/> <li> job_type : {<br/> id: 1,<br/> name: "Contingent"<br/> }<br/> </li><br/><br/> <h4>Commission Rate</h4><br/> <li> commission_rate : 5<br/> </li><br/><br/><b>Engagement Type : Contract</b><br/> <h4>Job Type</h4><br/> <li> job_type : {<br/> id: 3,<br/> name: "Contract"<br/> }<br/> </li><br/><br/> <h4>Contract Start Date</h4><br/> <li> contract_start_date : "2022-08-29"<br/> </li><br/><br/> <h4>Contract End Date</h4><br/> <li> contract_end_date : "2022-08-31"<br/> </li><br/><br/> <h4>Pay Rate</h4><br/> <li> pay_rate : {<br/> currency: "USD",<br/> number: 5000,<br/> frequency: {<br/> display_name: "hr",<br/> id: 1,<br/> name: "hour"<br/> }<br/> }<br/> </li><br/><br/> <h4>Bill Rate</h4><br/> <li> bill_rate : {<br/> currency: "INR",<br/> number: "5000",<br/> frequency: {<br/> display_name: "hr",<br/> id: 1,<br/> name: "hour"<br/> }<br/> }<br/> </li><br/><br/> <h4>Work Hours</h4><br/> <li> work_quantum : {<br/> frequency : {<br/> display_name: "day",<br/> id: 1,<br/> name: "day"<br/> },<br/> is_full_time : false,<br/> number : 2,<br/> unit : {<br/> display_name: "hours",<br/> id: 1,<br/> name: "hour"<br/> }<br/> }<br/> </li><br/><br/><b>Engagement Type : Retained</b><br/> <h4>Job Type</h4><br/> <li> job_type : {<br/> id: 2,<br/> name: "Retained"<br/> }<br/> </li><br/><br/> <h4>Expected Fee</h4><br/> <li> expected_fee : {<br/> currency: "USD",<br/> number: 35000<br/> }<br/> </li><br/><br/> <h4>Expected Start Date</h4><br/> <li> expected_start_date : "2022-08-29"<br/> </li><br/><br/> <h4>Expected End Date</h4><br/> <li> expected_end_date : "2022-08-31"<br/> </li><br/><br/><b>Engagement Type : Temporary</b><br/> <h4>Job Type</h4><br/> <li> job_type : {<br/> id: 4,<br/> name: "Temporary"<br/> }<br/> </li><br/><br/> <h4>Pay Rate</h4><br/> <li> pay_rate : {<br/> currency: "USD",<br/> number: 5000,<br/> frequency: {<br/> display_name: "hr",<br/> id: 1,<br/> name: "hour"<br/> }<br/> }<br/> </li><br/><br/> <h4>Bill Rate</h4><br/> <li> bill_rate : {<br/> currency: "INR",<br/> number: "5000",<br/> frequency: {<br/> display_name: "hr",<br/> id: 1,<br/> name: "hour"<br/> }<br/> }<br/> </li><br/><br/> <h4>Work Hours</h4><br/> <li> work_quantum : {<br/> frequency : {<br/> display_name: "day",<br/> id: 1,<br/> name: "day"<br/> },<br/> is_full_time : false,<br/> number : 2,<br/> unit : {<br/> display_name: "hours",<br/> id: 1,<br/> name: "hour"<br/> }<br/> }<br/> </li><br/>

get/api/external/job

Query parameters

job_idinteger required
include_stagesinteger

Headers

RF-Api-Keystring

Response

Auto generated using Swagger Inspector

{"stackTrail":"paths:/api/external/job:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"about_position":"<div>Test Job</div>","application_form":[{"parts":[{"key":"personal_info.name","type":"short_text"}],"requirement":"mandatory","text":"Name","type":"short_text"},{"parts":[{"key":"personal_info.email","type":"short_text"}],"requirement":"optional","text":"Email","type":"short_text"},{"parts":[{"key":"personal_info.phone","type":"short_text"}],"requirement":"optional","text":"Phone","type":"short_text"},{"parts":[{"key":"personal_info.location.city","type":"long_text"},{"key":"personal_info.location.state","type":"long_text"},{"key":"personal_info.location.country","type":"long_text"},{"key":"personal_info.location.postal_code","type":"long_text"}],"requirement":"optional","text":"Location","type":"location"}],"apply_link":"https://rfstaging.xyz/recruiterflowstaging/jobs/1","bill_rate":{"currency":"INR","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":"5000"},"company":{"id":1,"img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/entity-profile-pictures/prod/recruiterflowagency/3/2/q8fhvjf0.jpeg","name":"Guarented I"},"contacts":{"email":"firstcontact@company.com","id":1,"name":"First Contact"},"contract_end_date":"2022-08-31","contract_start_date":"2022-08-29","custom_fields":[{"id":64,"name":"Number field","value":2},{"id":52,"name":"Status","value":"Lead"},{"id":63,"name":"Input field","value":"edfvfd"},{"id":38,"name":"Contract Type","value":"2 week contract"}],"department":"Engineering","employment_type":"Contract","experience_range_end":2,"experience_range_start":1,"files":[{"file_id":48,"filename":"8202:88.docx","link":"https://com-recruiterflow-document-store-eu.s3.amazonaws.com/db_b18c893c749e320e66fbb2f7fef6b1be/documents/48/8202%3A88.docx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJGJEHP5AAWSJVTMA%2F20210119%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210119T084101Z&X-Amz-Expires=604700&X-Amz-SignedHeaders=host&X-Amz-Signature=260d9d5078b196fd494d0442524a34599072fbc3b5b293c99898c5e311a458d3","permission":1,"source":"document store","upload_time":null}],"hiring_team":[{"email":"admin@rfstaging.xyz","first_name":"Chérôme","img_link":"https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/10447/profile-picture.jpe","last_name":"Shenoy","name":"Chérôme Shenoy","role":"Recruiter","role_id":2,"user_id":10447}],"id":1,"is_open":true,"job_status":{"color":"#FF0000","id":1,"name":"Status 1"},"job_type":{"id":3,"name":"Contract"},"job_visibility_id":1,"job_visibility_info":{"close_reasons":[1,2],"closed_on":"2022-08-31","visibility_id":1},"locations":[{"city":"London","country":"United Kingdom","id":4,"iso_3166_1_alpha_2_code":"GB","name":"London","postal_code":"SE1 9BG","state":null,"zipcode":"SE1 9BG"}],"name":"Staging Job 1","notes":[{"author":{"email":"birendra@recruiterflow.com","first_name":"Birendra","id":1,"img_link":null,"last_name":"Yadav","name":"Birendra Yadav"},"content":"Test note","created_time":"2025-11-05T07:10:00+0000","editable":false,"entities":[{"id":1,"name":"Avenger","type":4}],"id":2,"is_pinned":false,"privacy_level":"everyone","replies":[]}],"number_of_openings":1,"pay_rate":{"currency":"INR","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":"5000"},"publish_to_careers_page":true,"remote_status":{"id":2,"name":"Not Remote"},"salary_range_currency":"USD","salary_range_end":125000,"salary_range_start":100000,"skills":[],"title":"Staging Job 1","work_quantum":{"frequency":{"display_name":"day","id":1,"name":"day"},"is_full_time":false,"number":"2","unit":{"display_name":"hours","id":1,"name":"hour"}}}}

Example response

{
  "about_position": "<div>Test Job</div>",
  "application_form": [
    {
      "parts": [
        {
          "key": "personal_info.name",
          "type": "short_text"
        }
      ],
      "requirement": "mandatory",
      "text": "Name",
      "type": "short_text"
    },
    {
      "parts": [
        {
          "key": "personal_info.email",
          "type": "short_text"
        }
      ],
      "requirement": "optional",
      "text": "Email",
      "type": "short_text"
    },
    {
      "parts": [
        {
          "key": "personal_info.phone",
          "type": "short_text"
        }
      ],
      "requirement": "optional",
      "text": "Phone",
      "type": "short_text"
    },
    {
      "parts": [
        {
          "key": "personal_info.location.city",
          "type": "long_text"
        },
        {
          "key": "personal_info.location.state",
          "type": "long_text"
        },
        {
          "key": "personal_info.location.country",
          "type": "long_text"
        },
        {
          "key": "personal_info.location.postal_code",
          "type": "long_text"
        }
      ],
      "requirement": "optional",
      "text": "Location",
      "type": "location"
    }
  ],
  "apply_link": "https://rfstaging.xyz/recruiterflowstaging/jobs/1",
  "bill_rate": {
    "currency": "INR",
    "frequency": {
      "display_name": "hr",
      "id": 1,
      "name": "hour"
    },
    "number": "5000"
  },
  "company": {
    "id": 1,
    "img_link": "https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/entity-profile-pictures/prod/recruiterflowagency/3/2/q8fhvjf0.jpeg",
    "name": "Guarented I"
  },
  "contacts": {
    "email": "firstcontact@company.com",
    "id": 1,
    "name": "First Contact"
  },
  "contract_end_date": "2022-08-31",
  "contract_start_date": "2022-08-29",
  "custom_fields": [
    {
      "id": 64,
      "name": "Number field",
      "value": 2
    },
    {
      "id": 52,
      "name": "Status",
      "value": "Lead"
    },
    {
      "id": 63,
      "name": "Input field",
      "value": "edfvfd"
    },
    {
      "id": 38,
      "name": "Contract Type",
      "value": "2 week contract"
    }
  ],
  "department": "Engineering",
  "employment_type": "Contract",
  "experience_range_end": 2,
  "experience_range_start": 1,
  "files": [
    {
      "file_id": 48,
      "filename": "8202:88.docx",
      "link": "https://com-recruiterflow-document-store-eu.s3.amazonaws.com/db_b18c893c749e320e66fbb2f7fef6b1be/documents/48/8202%3A88.docx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJGJEHP5AAWSJVTMA%2F20210119%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210119T084101Z&X-Amz-Expires=604700&X-Amz-SignedHeaders=host&X-Amz-Signature=260d9d5078b196fd494d0442524a34599072fbc3b5b293c99898c5e311a458d3",
      "permission": 1,
      "source": "document store",
      "upload_time": null
    }
  ],
  "hiring_team": [
    {
      "email": "admin@rfstaging.xyz",
      "first_name": "Chérôme",
      "img_link": "https://s3-eu-central-1.amazonaws.com/com-recruiterflow-static-content-eu/user-profile-pictures/10447/profile-picture.jpe",
      "last_name": "Shenoy",
      "name": "Chérôme Shenoy",
      "role": "Recruiter",
      "role_id": 2,
      "user_id": 10447
    }
  ],
  "id": 1,
  "is_open": true,
  "job_status": {
    "color": "#FF0000",
    "id": 1,
    "name": "Status 1"
  },
  "job_type": {
    "id": 3,
    "name": "Contract"
  },
  "job_visibility_id": 1,
  "job_visibility_info": {
    "close_reasons": [
      1,
      2
    ],
    "closed_on": "2022-08-31",
    "visibility_id": 1
  },
  "locations": [
    {
      "city": "London",
      "country": "United Kingdom",
      "id": 4,
      "iso_3166_1_alpha_2_code": "GB",
      "name": "London",
      "postal_code": "SE1 9BG",
      "state": null,
      "zipcode": "SE1 9BG"
    }
  ],
  "name": "Staging Job 1",
  "notes": [
    {
      "author": {
        "email": "birendra@recruiterflow.com",
        "first_name": "Birendra",
        "id": 1,
        "img_link": null,
        "last_name": "Yadav",
        "name": "Birendra Yadav"
      },
      "content": "Test note",
      "created_time": "2025-11-05T07:10:00+0000",
      "editable": false,
      "entities": [
        {
          "id": 1,
          "name": "Avenger",
          "type": 4
        }
      ],
      "id": 2,
      "is_pinned": false,
      "privacy_level": "everyone",
      "replies": []
    }
  ],
  "number_of_openings": 1,
  "pay_rate": {
    "currency": "INR",
    "frequency": {
      "display_name": "hr",
      "id": 1,
      "name": "hour"
    },
    "number": "5000"
  },
  "publish_to_careers_page": true,
  "remote_status": {
    "id": 2,
    "name": "Not Remote"
  },
  "salary_range_currency": "USD",
  "salary_range_end": 125000,
  "salary_range_start": 100000,
  "skills": [],
  "title": "Staging Job 1",
  "work_quantum": {
    "frequency": {
      "display_name": "day",
      "id": 1,
      "name": "day"
    },
    "is_full_time": false,
    "number": "2",
    "unit": {
      "display_name": "hours",
      "id": 1,
      "name": "hour"
    }
  }
}