{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"976d15af-0468-4cf1-9252-87cf03eb982f","name":"ReloTalent for Providers Public APIs","description":"This documentation has for scope to introduce users to Relotalent Business Providers (DSP) API functionalities.\n\nBusiness DSP APIs allow users to perform API calls within a given ReloTalent DSP account, such as:\n\n- manage Accounts;\n    \n- manage Contacts;\n    \n- manage Users;\n    \n- manage Assignees and their Personal Documents;\n    \n- manage Dependents and their Personal Documents,\n    \n- manage Assignments;\n    \n- manage Relocations;\n    \n- manage Services;\n    \n- manage Tasks;\n    \n- launch Assignment Workflows;\n    \n- launch Relocation Workflows;\n    \n- launch Service Workflows;\n    \n- manage Media and Files;\n    \n- manage Comments;\n    \n- manage Quotes;\n    \n- manage Invoices;\n    \n- manage Invoiceable expenses;\n    \n- manage Credit Notes;\n    \n- manage Purchase invoices (Bills);\n    \n- manage Transactions;\n    \n- manage Timelogs;\n    \n- manage Expenses\n    \n- manage Recurrent Expenses;\n    \n- retreive Countries or Cities;\n    \n- retreive system Attributes, Variables and Values.\n    \n\n---\n\nThe main purpose of ReloTalent Business DSP APIs is to:\n\n- enable integration between client's ReloTalent account and third party platforms;\n    \n- generate reports into their datawarehouse;\n    \n- enable teams to work with their connected HRs;\n    \n- share information to third party actors (such as RMC).\n    \n\n---\n\n# Hosts\n\n| **Environment** | **Host** |\n| --- | --- |\n| **Testing / UAT (Thinhdev)** | [<b>https://thinhdev-publicapi.reloday.com/</b>](https://thinhdev-publicapi.reloday.com/) |\n| **Production** | [<b>https://public-api.relotalent.com</b>](https://public-api.relotalent.com/) |\n\n---\n\n# Admitted Roles\n\nPlease note that, in order to use Public APIs, the user carrying the API key used must be granted **Admin Role**.\n\nFor maximum control it is recommended to create a dedicated user for the sake of API usage and set it as Admin, this will allow better traceability of actions and will reduce the risk of API integration being accidentally broken by an involuntary change of User Role.\n\n# Error Codes\n\nThe following common error codes might be returned when using the APIs.\n\n| **Issue** | **Code** |\n| --- | --- |\n| API Key is incorrect or incomplete | INVALID_API_KEY |\n| User profile could not be found | USER_PROFILE_NOT_FOUND |\n| User profile is not activated | USER_PROFILE_NOT_ACTIVATED |\n| API Key expired or inactive | AUTHENTICATION_KEY_EXPIRED |\n| User associated with API Key does not have an Admin Role | ROLE_BASED_ACCESS_DENIED_INSUFFICENT_PERMISSION |\n| API Key could not be located/missing | INVALID_API_KEY |\n| User associated with API Key does not belong to GMS environment | ROLE_BASED_ACCESS_DENIED_WRONG_ENVIRONMENT |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7833272","team":299109,"collectionId":"976d15af-0468-4cf1-9252-87cf03eb982f","publishedId":"2s93eZys4b","public":true,"publicUrl":"https://developer-provider-business-api.relotalent.com","privateUrl":"https://go.postman.co/documentation/7833272-976d15af-0468-4cf1-9252-87cf03eb982f","customColor":{"top-bar":"FFFFFF","right-sidebar":"404040","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/3bc0350d-f83e-489d-9829-8d6d71ede43e/cmVsb3RhbGVudF9sb2dvX3doaXRlX3NtYWxsLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"404040","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"404040","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-05-12T04:49:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":"https://content.pstmn.io/3bc0350d-f83e-489d-9829-8d6d71ede43e/cmVsb3RhbGVudF9sb2dvX3doaXRlX3NtYWxsLnBuZw=="}},"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/9a4738db0a043c2534da080ed7b4db63cea3088b39d6e6c12def4dac28e1ef94","favicon":"https://relotalent.com/favicon.ico"},"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://developer-provider-business-api.relotalent.com/view/metadata/2s93eZys4b"}