{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d7199b75-4768-4e35-b28f-0aa48b8adc92","name":"AvaHR","description":"## **Welcome to the AvaHR API Documentation!**\n\nWe’re excited to guide you through the powerful tools and capabilities our Applicant Tracking System (ATS) API offers for enhancing your HR applications.\n\n## **About AvaHR API**\n\nThe AvaHR API is designed to streamline recruitment processes by offering a comprehensive suite of features, such as candidate management and job posting, to optimize your hiring workflow.  \nBuilt with secure OAuth authentication and compliant with App Transport Security (ATS) standards, the AvaHR API ensures both efficiency and data security for your HR solutions.\n\n### **Key Features**\n\n- **Comprehensive ATS Solution:** Simplify every step of the hiring process with tools like automated resume parsing, customizable culture profiles, and branded career pages to attract top talent aligned with your company’s values.\n    \n- **Effortless Candidate Communication:** Engage candidates effectively with built-in text messaging, email templates, and support for eSignatures and pre-built offer letters.\n    \n- **Powerful Integrations:** Connect seamlessly with over 860 tools, including Slack, Zoom, and Microsoft platforms, to streamline your workflows.\n    \n- **Enhanced Job Distribution:** Broaden your reach by sharing job postings on multiple platforms, including social media, and set up employee referral programs with ease.\n    \n- **User-Friendly Design:** Manage your hiring process through an intuitive dashboard, available on desktop and mobile, to ensure a seamless recruitment experience.\n    \n- **Cost-Effective Solutions:** Tailored for SMBs and startups, the API combines affordability with advanced recruitment features.\n    \n\nThe AvaHR API is your partner in creating efficient, engaging, and secure hiring processes. Get started today and transform your recruitment strategy!\n\n## **Getting Started**\n\nUnlock the full potential of streamlined recruitment for your HR applications by following these simple steps to get started with our Applicant Tracking System (ATS) API.\n\n### **Step 1: Sign Up or Log In**\n\n- **New Users:** Sign up for a AvaHR account on our [Sign-Up Page](https://app.avahr.com/get-started).\n    \n- **Existing Users:** Simply [log in](https://app.avahr.com/login) to your AvaHR account using your credentials.\n    \n\n### **Step 2: Access Company Profile Settings**\n\n- Once logged in, navigate to the **Company** menu tab in the dashboard.\n    \n- Select the **Company Profile** submenu tab.\n    \n\nAlternatively, you can directly access the **Company Profile Settings** [here](https://app.avahr.com/settings/profile).\n\n### **Step 3: Generate OAuth Credentials**\n\nTo integrate your applications with the AvaHR API, you’ll need to generate OAuth credentials (Client ID and Client Secret).\n\nFollow these steps:\n\n1. Scroll down to the **AvaHR API Console** section within the **Company Profile Settings**.\n    \n2. Click the **New Client** button to create a new set of OAuth credentials.\n    \n3. **Choose Your Integration Option:**\n    \n\n- **WP Plugin**: Select this option if you’re integrating with a WordPress website.\n    \n- **Other Integrations**: Choose this if you plan to integrate the API with custom applications or third-party platforms.\n    \n\nUse these credentials to authenticate your API requests securely and start integrating the AvaHR API into your HR solutions.\n\n### **Step 4: Explore API Documentation:**\n\nNow that you have your OAuth credentials, you're ready to explore the API documentation:\n\n1. Check out the API Endpoints to understand the functionalities available.\n    \n2. Review the Authentication section for guidance on securely integrating OAuth into your application.\n    \n3. Explore Code Samples in various programming languages to kickstart your development.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"26810652","team":4934180,"collectionId":"d7199b75-4768-4e35-b28f-0aa48b8adc92","publishedId":"2sB2cPi5D7","public":true,"publicUrl":"https://developer.avahr.com","privateUrl":"https://go.postman.co/documentation/26810652-d7199b75-4768-4e35-b28f-0aa48b8adc92","customColor":{"top-bar":"0B363C","right-sidebar":"0B363C","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/88a156f8-1029-4304-a2a1-e9d5c6e5e324/YXZhaHIucG5n","colors":{"top-bar":"0B363C","right-sidebar":"0B363C","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/e292b27a-27d4-4efb-864a-545104f2b366/YXJ0d29yay5wbmc=","colors":{"top-bar":"0B363C","right-sidebar":"0B363C","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-08-20T13:02:08.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/e292b27a-27d4-4efb-864a-545104f2b366/YXJ0d29yay5wbmc=","logoDark":"https://content.pstmn.io/88a156f8-1029-4304-a2a1-e9d5c6e5e324/YXZhaHIucG5n"}},"statusCode":200},"environments":[{"name":"Live","id":"d4a617cf-5767-4e93-9e9f-fc702c4d5051","owner":"26810652","values":[{"key":"base_url","value":"","enabled":true,"type":"default"},{"key":"client_id","value":"","enabled":true,"type":"default"},{"key":"client_secret","value":"","enabled":true,"type":"secret"},{"key":"state","value":"","enabled":true,"type":"default"},{"key":"code","value":"","enabled":true,"type":"default"},{"key":"access_token","value":"","enabled":true,"type":"secret"},{"key":"expires_in","value":"","enabled":true,"type":"default"},{"key":"token_type","value":"","enabled":true,"type":"default"},{"key":"scope","value":"","enabled":true,"type":"default"},{"key":"refresh_token","value":"","enabled":true,"type":"secret"},{"key":"department_id","value":"","enabled":true,"type":"default"},{"key":"candidate_id","value":"1146686","enabled":true,"type":"default"},{"key":"team_member_employer_id","value":"","enabled":true,"type":"default"},{"key":"location_id","value":"","enabled":true,"type":"default"},{"key":"redirect_uri","value":"https://oauth.pstmn.io/v1/callback","enabled":true,"type":"default"},{"key":"job_id","value":"","enabled":true,"type":"any"},{"key":"employer_id","value":"","enabled":true,"type":"any"},{"key":"job_type","value":"","enabled":true,"type":"any"},{"key":"culture_profile_id","value":"","enabled":true,"type":"any"},{"key":"scorecard_id","value":"","enabled":true,"type":"any"},{"key":"pipeline_id","value":"","enabled":true,"type":"any"},{"key":"skill_level","value":"","enabled":true,"type":"any"},{"key":"job_visibility_id","value":"","enabled":true,"type":"any"},{"key":"industry_id","value":"","enabled":true,"type":"any"},{"key":"job_function_id","value":"","enabled":true,"type":"any"},{"key":"location_type","value":"","enabled":true,"type":"any"},{"key":"salary_type","value":"","enabled":true,"type":"any"}],"published":true}],"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/c5ec3b00dfdd0f377868770838baedca78bed44de29a516e0d5bb372f6ea3e68","favicon":"https://avahr.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"},{"label":"Live","value":"26810652-d4a617cf-5767-4e93-9e9f-fc702c4d5051"}],"canonicalUrl":"https://developer.avahr.com/view/metadata/2sB2cPi5D7"}