{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e24e97df-030b-4498-b4bd-5405d429d80a","name":"Jobtrain - OpenAPI","description":"_Current Version: 1.0_\n\n_Last Revision: 20/10/25_\n\nJobtrain's OpenAPI based on the OpenAPI 3.0 specification. You can find out more about Jobtrain at [https://jobtrain.co.uk](https://jobtrain.co.uk).\n\nJobtrain's API enables client internal IT/software teams or authorized third parties to build integrations with Jobtrain and provides a standard interface for data exchange.\n\nIf you would like to use the API to build your own integrations, speak with your Continuous Improvement Consultant about arranging a Partnership Agreement, after which, we can provide your Client ID and credentials.\n\nIf you have any queries regarding the API, please get in touch with our [Support Team](https://clientsupport.jobtrain.co.uk/support/home).\n\n## **FAQs**\n\n1. Why am I not getting the number of expected records? There are 300 candidates in a job, but I'm only seeing 20.\n \n 1. By default the page size is limited to 20 records. This can be changed using the PageSize parameter, up to a max of 100.\n \n 2. To retrieve more records, please use pagination to move between the pages. This can be controlled using the PageNo parameter.\n \n2. What's the difference between total and results?\n \n 1. At the top of some calls, you may see these two numbers.\n \n 2. Total is the overall number of records returned via that call.\n \n 3. Results is the number of those overall records being shown in the current page. This will usually be the same as PageSize, unless there are too few results to fill the page.\n \n\n\n\n## Response Codes:\n\n| **Status Code** | **Description** |\n| --- | --- |\n| 200 OK | Indicates that the request has succeeded. |\n| 400 Invalid Format | The server cannot understand the information that you are trying to send because it is not in the correct format. This could be due to a number of reasons, such as incorrect data types, missing or incomplete fields, or an issue with the way the data is being formatted.

To resolve this issue, double-check the data that you are sending and ensure that it is in the correct format. |\n| 401 Access Denied | You do not have the necessary permissions to access the information or perform the action you requested. This could be due to several reasons, such as an expired session, invalid credentials, or insufficient privileges.

To resolve this error, you should verify that you have entered the correct credentials and try again. |\n| 403 Authentication Failure | You do not have the necessary permissions to access the requested resource. To resolve this error, you should verify that you are using the correct authentication credentials and that your user account has the necessary permissions to access the resource. |\n| 404 Job or Application data does not exist | This job / application does not exist. Please verify that you have entered the correct ID and that the job / application still exists in Jobtrain. |\n| 408 Request Timeout | The server did not receive a complete request from the client within the time frame allowed for the request to be completed.

This could happen due to a slow network connection, high traffic on the server, or a long processing time required for the request.

Try resending the request to the server. If the issue persists, you may need to check your network connection or contact the server administrator or support team for further assistance in resolving the issue. |\n| 409 Duplicate Data | Your request included data that already exists in the database.

To resolve this error, you should verify that the data you are submitting is unique and does not conflict with existing data on the server.

Candidate data must have a unique email address AND first name + surname + postcode must be unique. |\n| 410 Job Closed | The job you are trying to access or perform an action against is now closed. |\n| 413 Files are too large | The payload (i.e., the data being sent) is too large.

Try reducing the size of the payload by compressing files or reducing the amount of data being sent.

CVs and files must be less than 1MB. |\n| 418 I’m a Teapot | This is not a valid HTTP status code and is intended as a joke or for testing purposes only. Please check your request and try again with a valid HTTP status code. |\n| 422 Mandatory field missing | The server was unable to process the request because a mandatory field is missing or contains invalid data.

This error typically occurs when a required field is left blank or contains data that does not meet requirements, such as an invalid data type or format. It can also occur if a client tries to submit a request without providing all the necessary data or with data that does not meet the validation rules.

To resolve this error, you should review the data you are trying to submit and ensure that all mandatory fields are present and contain valid data. You may also need to review Jobtrain’s validation rules and ensure that your data meets those requirements. |\n| 429 Too Many Requests | The client has sent too many requests in a given period and the server is temporarily unable to handle additional requests. The client should reduce the rate of requests and try again later. |\n| 500 Internal Server Error | There may be a problem with the server's configuration (this could be a misconfigured setting or insufficient system resources caused by a high volume of traffic).

To resolve this error, you should try repeating the action that caused the error.

If the error persists, you may need to wait and try again later, as the issue may be temporary and resolved by the server automatically.

If the issue continues, you may need to contact the support team for further assistance in resolving the issue. |\n| 503 Service Unavailable | The server is temporarily unable to handle the request due to maintenance or overload.

To resolve this error, you should try repeating the action that caused the error after a few minutes or wait for the server to complete maintenance.

If the error persists, you may need to contact the support team. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"28190791","collectionId":"e24e97df-030b-4498-b4bd-5405d429d80a","publishedId":"2s9Y5SV57T","public":true,"publicUrl":"https://documenter-api.postman.tech/view/28190791/2s9Y5SV57T","privateUrl":"https://go.postman.co/documentation/28190791-e24e97df-030b-4498-b4bd-5405d429d80a","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"177e9c"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Jobtrain - Open API"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/36f3bed9-07c0-403d-bac1-33a734f5570c/Sm9idHJhaW4gQm9iIHRyYW5zcGFyZW50IDEwMjR4MTAyNC5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"177e9c"}},{"name":"light","logo":"https://content.pstmn.io/36f3bed9-07c0-403d-bac1-33a734f5570c/Sm9idHJhaW4gQm9iIHRyYW5zcGFyZW50IDEwMjR4MTAyNC5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"177e9c"}}]}},"version":"8.10.0","publishDate":"2026-01-19T14:18:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Jobtrain - Open API","description":""},"logos":{"logoLight":"https://content.pstmn.io/36f3bed9-07c0-403d-bac1-33a734f5570c/Sm9idHJhaW4gQm9iIHRyYW5zcGFyZW50IDEwMjR4MTAyNC5wbmc=","logoDark":"https://content.pstmn.io/36f3bed9-07c0-403d-bac1-33a734f5570c/Sm9idHJhaW4gQm9iIHRyYW5zcGFyZW50IDEwMjR4MTAyNC5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s9Y5SV57T"}