StartFlowJobList job postingsGet job postingRegionLocationTitlePositionDepartmentRequisitionUserWebhooks
Job
Manage job postings
List job postings
Returns the list of all job postings.
Request Information
GEThttps://api-test.hrpeak.com/v2/jobs
The API uses basic authentication and the API key must be sent in the Authorization request header.
curl https://api-test.hrpeak.com/v2/jobs
     -H "Authorization: API_KEY"
URI parameters
pageoptional
The zero-based page number. Data type is integer. Default value is 0.
per_pageoptional
The number of items per page. Maximum value is 1000. Data type is integer. Default value is 100.
department_idoptional
Filter job postings by department. Unique id of the department.
department_external_idoptional
Filter job postings by department. A unique string to associate the department to an external record.
tag_idoptional
Filter job postings by tag. Unique id of the tag.
statusoptional
Filter job postings by status. Data type is integer.
Possible values
ValueText
0Passive
1Active
2Archive
internaloptional
Filter job postings by status. Include or exclude internal job postings. Data type is integer. Default value is 0.
Possible values
ValueText
0Exclude internal job postings
1Only internals
2All
languageoptional
Job postings can be multilingual. The language of the job posting. Data type is integer. Default value is English.
Possible values
ValueText
0English
1Turkish
Request Uri Sample
https://api-test.hrpeak.com/v2/jobs/?page=0&per_page=20&status=1
Response Information
id
Unique id of the job.
title
Title of the job posting.
ref_code
Unique reference code for each of jobs
location
Location of the job posting.
employment_type
Employment type of the job posting. Data type is integer.
Possible values
ValueText
0Full Time
1Part Time
2Intern
3Temporary
workplace
Workplace of the job posting. Data type is integer.
Possible values
ValueText
0On Site
1Remote
2Hybrid
date
Date of the job posting, if published. Data type is datetime.
status
Status of the job posting. Data type is integer.
Possible values
ValueText
0Passive
1Active
2Archive
internal
This property value is set to true if the job posting is marked as internal. Data type is boolean.
department
Department of the job posting.
id
Unique id of the department.
name
Name of the department.
tags
Tags of the job posting. This property value is an array.
id
Unique id of the tag.
name
Name of the tag.
private
This property value is set to true if the tag is private. Data type is boolean.
Sample Response
{
  "status": 0,
  "total_data_count": 1000,
  "data": [
    {
      "id": "ezfstydl84svw3bbsk3h55tabq",
      "title": "Recruitment Specialist",
      "ref_code": "RS01",
      "location": "California",
      "employment_type": 0,
      "workplace": 0,
      "date": "2026-08-04T04:22:00Z",
      "status": 2,
      "department": {
        "id": "jzgpa8g2jgs8y5z8z4eerwsmqw",
        "name": "Recruiting Team"
      },
      "tags": [
        {
          "id": "e2zcy2k57uqvw6x9s6c2jd6j22",
          "name": "Tag 01"
        }
      ]
    }
  ]
}
Error Responses
Error messages can vary. More specific error information may be included.
Internal server error
{
  "status": 500,
  "error_message": "A generic error has occurred on the server."
}
Get job posting
Returns the details of a job posting.
Request Information
GEThttps://api-test.hrpeak.com/v2/jobs/{id}
The API uses basic authentication and the API key must be sent in the Authorization request header.
curl https://api-test.hrpeak.com/v2/jobs/{id}
     -H "Authorization: API_KEY"
URI parameters
idrequired
Unique id of the job.
languageoptional
Job postings can be multilingual. The language of the job posting. Data type is integer. Default value is English.
Possible values
ValueText
0English
1Turkish
Request Uri Sample
https://api-test.hrpeak.com/v2/jobs/ha4e35v38snswzbqgljdlxw26q
Response Information
title
Title of the job posting.
ref_code
Unique reference code for each of jobs
location
Location of the job posting.
content
Content of the job posting.
keywords
Keywords of the job posting.
number_of_personnel
Number of personnel of the job posting. Data type is integer.
employment_type
Employment type of the job posting. Data type is integer.
Possible values
ValueText
0Full Time
1Part Time
2Intern
3Temporary
workplace
Workplace of the job posting. Data type is integer.
Possible values
ValueText
0On Site
1Remote
2Hybrid
date
Date of the job posting, if published. Data type is datetime.
last_application_date
Last application date of the job posting. Data type is datetime.
status
Status of the job posting. Data type is integer.
Possible values
ValueText
0Passive
1Active
2Archive
internal
This property value is set to true if the job posting is marked as internal. Data type is boolean.
department
Department of the job posting.
id
Unique id of the department.
name
Name of the department.
tags
Tags of the job posting. This property value is an array.
id
Unique id of the tag.
name
Name of the tag.
private
This property value is set to true if the tag is private. Data type is boolean.
Sample Response
{
  "status": 0,
  "data": {
    "title": "Recruitment Specialist",
    "ref_code": "RS01",
    "location": "California",
    "content": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.",
    "keywords": "HR, Recruitment, Assessment",
    "number_of_personnel": 1,
    "employment_type": 0,
    "workplace": 0,
    "date": "2026-08-04T04:22:00Z",
    "last_application_date": "2026-08-04T04:22:00Z",
    "status": 2,
    "department": {
      "id": "cdewl9rw4kyaw5zmxxjsl2y4fa",
      "name": "Recruiting Team"
    },
    "tags": [
      {
        "id": "rkwyhd6afa32yzv5kz4h3a8stz",
        "name": "Tag 01"
      },
      {
        "id": "gdaa55vvm57tw5lmrux8v8962x",
        "name": "Tag 02",
        "private": true
      }
    ]
  }
}
Error Responses
Error messages can vary. More specific error information may be included.
Bad request
{
  "status": 400,
  "error_message": "Invalid request."
}
Not found
{
  "status": 404,
  "error_message": "Record not found."
}
Internal server error
{
  "status": 500,
  "error_message": "A generic error has occurred on the server."
}