v1

latestOpenAPI 3.0.02026-08-061280285.2 KB
Job APIs

Lists all jobs in the account.

<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/><br/> <h4>Notes</h4><br/> <li>"notes": [<br/> {<br/> "author": {<br/> "email": "test@xyz.com",<br/> "first_name": "Test",<br/> "id": 1,<br/> "img_link": null,<br/> "last_name": "user",<br/> "name": "Test user"<br/> },<br/> "content": 'Test note',<br/> "created_time": "2025-11-05T07:10:00+0000",<br/> "editable": false,<br/> "entities": [<br/> {<br/> "id": 1,<br/> "name": "Test job",<br/> "type": 4<br/> }<br/> ],<br/> "id": 2,<br/> "is_pinned": false,<br/> "privacy_level": "everyone",<br/> "replies": []<br/> }<br/> ]<br/> </li><br/><br/><b>Note: Structure changes to {"data": [], "total_items": int, "total_current_openings": int} when include_count is enabled.</b><br><br/><br/>

get/api/external/job/list

Query parameters

items_per_pagestring
current_pagestring
include_countstring

Count of total records

include_notesstring

Job Notes

include_descriptionstring

Job Description

only_openinteger

1 -> True, 0-> False

Headers

RF-Api-Keystring

Response

Auto generated using Swagger Inspector

{"stackTrail":"paths:/api/external/job/list:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":[{"about_position":"This is a test job","apply_link":"https://rfstaging.xyz/recruiterflowstaging/jobs/1","bill_rate":{"currency":"INR","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":"5000"},"commission_rate":5,"contract_end_date":"2022-08-31","contract_start_date":"2022-08-29","current_opening":1,"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,"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,"last_opened":"2025-05-26T13:13:33+05:30","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"}],"maildrop_email":"maildrop+recruiterflowcompany_3170f227@recruiterflow.com","name":"Staging Job 1","number_of_openings":1,"pay_rate":{"currency":"INR","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":"5000"},"publish_to_careers_page":true,"salary_frequency":"month","salary_range_currency":"USD","salary_range_end":5000,"salary_range_start":1000,"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": "This is a test job",
    "apply_link": "https://rfstaging.xyz/recruiterflowstaging/jobs/1",
    "bill_rate": {
      "currency": "INR",
      "frequency": {
        "display_name": "hr",
        "id": 1,
        "name": "hour"
      },
      "number": "5000"
    },
    "commission_rate": 5,
    "contract_end_date": "2022-08-31",
    "contract_start_date": "2022-08-29",
    "current_opening": 1,
    "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,
    "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,
    "last_opened": "2025-05-26T13:13:33+05:30",
    "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"
      }
    ],
    "maildrop_email": "maildrop+recruiterflowcompany_3170f227@recruiterflow.com",
    "name": "Staging Job 1",
    "number_of_openings": 1,
    "pay_rate": {
      "currency": "INR",
      "frequency": {
        "display_name": "hr",
        "id": 1,
        "name": "hour"
      },
      "number": "5000"
    },
    "publish_to_careers_page": true,
    "salary_frequency": "month",
    "salary_range_currency": "USD",
    "salary_range_end": 5000,
    "salary_range_start": 1000,
    "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"
      }
    }
  }
]