{"id":4162,"date":"2024-04-30T10:46:38","date_gmt":"2024-04-30T08:46:38","guid":{"rendered":"https:\/\/modulus.help\/kb\/docs\/documentation\/recruitment-apis-v1\/api-vacancies-list\/"},"modified":"2024-05-30T12:10:58","modified_gmt":"2024-05-30T10:10:58","slug":"api-vacancies-list","status":"publish","type":"docs","link":"https:\/\/modulus.help\/kb\/docs\/documentation\/recruitment-apis-v1\/api-vacancies-list\/","title":{"rendered":"API: Vacancies List"},"content":{"rendered":"

The purpose of this API is to list vacancies.<\/p>\n

Request<\/h4>\n\n\n\n\n\n\n\n
URL<\/th>\nhttps:\/\/your_account.modulus.biz\/api\/rec\/v1\/vacancies?token=YOUR_TOKEN<\/td>\n<\/tr>\n
API Name<\/th>\nVacancies<\/td>\n<\/tr>\n
Method<\/th>\nGET<\/td>\n<\/tr>\n
Source<\/th>\nThird Party Server<\/td>\n<\/tr>\n
Recipient<\/th>\nmodulus\u00ae Server<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Query String Parameters<\/h4>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nRequired<\/th>\nType<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
token<\/th>\nYes<\/td>\nText<\/td>\nYour authentication token.<\/td>\n<\/tr>\n
vacancy_code<\/th>\nNo<\/td>\ntext<\/td>\nSpecific vacancy code to list.<\/td>\n<\/tr>\n
department<\/th>\nNo<\/td>\ntext<\/td>\nDepartment name to list all vacancies under it.<\/td>\n<\/tr>\n
position<\/th>\nNo<\/td>\ntext<\/td>\nPosition name to list all vacancies under it.<\/td>\n<\/tr>\n
status<\/th>\nNo<\/td>\ntext<\/td>\nVacancy status possible values [LNG_ENUM_STATUS_PUBLISH, LNG_ENUM_STATUS_UNPUBLISH].<\/td>\n<\/tr>\n
status<\/th>\nNo<\/td>\ntext<\/td>\nVacancy status possible values [LNG_ENUM_STATUS_PUBLISH, LNG_ENUM_STATUS_UNPUBLISH].<\/td>\n<\/tr>\n
start_date_from<\/th>\nNo<\/td>\nDate<\/td>\nDate format must be ISO 8601 (Example: \u201c2020-01-10\u201d).<\/td>\n<\/tr>\n
start_date_to<\/th>\nNo<\/td>\nDate<\/td>\nDate format must be ISO 8601 (Example: \u201c2020-01-10\u201d).<\/td>\n<\/tr>\n
expire_date_from<\/th>\nNo<\/td>\nDate<\/td>\nDate format must be ISO 8601 (Example: \u201c2020-01-10\u201d).<\/td>\n<\/tr>\n
expire_date_to<\/th>\nNo<\/td>\nDate<\/td>\nDate format must be ISO 8601 (Example: \u201c2020-01-10\u201d).<\/td>\n<\/tr>\n
sort_by<\/th>\nNo<\/td>\nText<\/td>\nPossible values [vacancy_code, start_date, end_date].<\/td>\n<\/tr>\n
page_number<\/th>\nNo<\/td>\nNumber<\/td>\nWhich page to list default value is 1.<\/td>\n<\/tr>\n
page_size<\/th>\nNo<\/td>\nNumber<\/td>\nNumber of records per page value must be from 10 to 100 (if less than 10 use 10, if greater than 100 use 100) default value is 10.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Responses<\/h4>\n\n\n\n\n\n\n\n\n
HTTP Status<\/th>\nresult<\/th>\ntitle<\/th>\nmessage<\/th>\nobject<\/th>\n<\/tr>\n<\/thead>\n
Success Responses<\/th>\n<\/tr>\n
200 OK<\/td>\ntrue<\/td>\nSuccess<\/td>\nVacancies listed successfully.<\/td>\n\n
{\r\n  \"meta_data\": {\r\n    \"record_count\": 1,\r\n    \"page_count\": 1,\r\n    \"page_size\": 1,\r\n    \"page_number\": 1,\r\n  }\r\n  \"data\": [{\r\n    \"vacancy_code\": \"\",\r\n    \"department\": \"\",\r\n    \"position\": \"\",\r\n    \"start_date\": \"\",\r\n    \"expiry_date\": \"\",\r\n    \"short_description\": \"\"\r\n  }] \r\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n
Failure Responses<\/th>\n<\/tr>\n
500 Internal Server Error<\/td>\nfalse<\/td>\nError<\/td>\nError message describe the problem.<\/td>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Example<\/h4>\n\n\n\n\n
Request<\/th>\n\n
curl --request GET 'https:\/\/your_account.modulus.biz\/api\/rec\/v1\/vacancies?token=YOUR_TOKEN&page_size=30&page_number=1'<\/span>\r\n<\/code><\/pre>\n<\/td>\n<\/tr>\n
200 OK<\/th>\n\n
{\r\n  \"result\": true,\r\n  \"title\": \"Success\",\r\n  \"message\": \"Vacancies listed successfully.\",\r\n  \"object\": {\r\n    \"meta_data\": {\r\n      \"record_count\": 3,\r\n      \"page_count\": 1,\r\n      \"page_size\": 20,\r\n      \"page_number\": 1\r\n    },\r\n    \"data\": [\r\n      {\r\n        \"vacancy_code\": \"001-001\",\r\n        \"department\": \"Management\",\r\n        \"position\": \"HR\",\r\n        \"start_date\": \"2022-12-22\",\r\n        \"expiry_date\": \"2023-12-31\",\r\n        \"short_description\": \"Testing\"\r\n      },\r\n      {\r\n        \"vacancy_code\": \"005-003\",\r\n        \"department\": \"Customer Success\",\r\n        \"position\": \"Customer Support\",\r\n        \"start_date\": \"2024-04-08\",\r\n        \"expiry_date\": \"2024-04-30\",\r\n        \"short_description\": \"Testing 2\"\r\n      },\r\n      {\r\n        \"vacancy_code\": \"001-004\",\r\n        \"department\": \"Management\",\r\n        \"position\": \"Vice President\",\r\n        \"start_date\": \"2023-10-09\",\r\n        \"expiry_date\": \"2023-11-10\",\r\n        \"short_description\": \"Testing 3\"\r\n      }\r\n    ]\r\n  }\r\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"featured_media":0,"parent":4161,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"comment_count":0,"_links":{"self":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4162"}],"collection":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/comments?post=4162"}],"version-history":[{"count":2,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4162\/revisions"}],"predecessor-version":[{"id":4414,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4162\/revisions\/4414"}],"up":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4161"}],"wp:attachment":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/media?parent=4162"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/doc_tag?post=4162"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}