{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"00a43713-331d-4a76-b2ab-48f3151406d4","name":"Hirexpo Dev API - Documentation","description":"# **Hirexpo Dev API**\n\nWelcome to the **Hirexpo Dev API** documentation. This API offers access to multiple endpoints of the [Hirexpo Job Portal](https://www.hirexpo.com), allowing registered companies, candidates, and developers to integrate various job-related services into their applications. The API is structured into different categories, such as **Public Routes**, **Authentication Routes**, and **Filter Routes**, to enable efficient access to resources like job listings, companies, candidates, and more.\n\nThis API supports both public access and authenticated access through tokens. All authenticated routes require a valid token to be included in the request headers.\n\n## API Overview\n\n- **Base URL**: `https://hirexpo.com`\n    \n- **Authentication**: API uses **Sanctum** token-based authentication for all protected routes.\n    \n- **Data Formats**: All API responses are in JSON format.\n    \n\n### **API Structure**\n\n1. **Public Routes**:  \n    Endpoints in this section are publicly accessible and do not require authentication. These routes include access to general platform information, job listings, company profiles, and blog content.\n    \n2. **Authentication Routes**:  \n    These routes are for handling user authentication and interaction with the platform. This includes user registration, login, and logout, as well as fetching profile details, managing notifications, and interacting with candidate and company-specific features.\n    \n3. **Filter Routes**:  \n    These routes allow filtering of various entities like jobs, companies, and candidates. You can filter jobs by city, country, type, category, and salary, while companies and candidates can be filtered by location, industry, and more.\n    \n\n### **Authentication**\n\nThe **Hirexpo API** uses token-based authentication via **Sanctum**. To access secured endpoints, you must first obtain a **Bearer Token** by logging in. This token must be included in the `Authorization` header for all requests to protected routes.\n\n- **Token Format**: `Bearer`\n    \n- **Login Endpoint**: `POST https://hirexpo.com/api/login`\n    \n\n**Example Request Header**:\n\n```\nAuthorization: Bearer <token>\n\n ```\n\n### **Common Parameters**\n\n- **Pagination**:  \n    Most endpoints support pagination, allowing you to control the number of results returned per page.  \n    Example: `?page=2&limit=10`\n    \n- **Sorting**:  \n    Some endpoints support sorting results by various fields.  \n    Example: `?sort=created_at&order=desc`\n    \n- **Filtering**:  \n    The API supports filtering across different entities like jobs, candidates, and companies.  \n    Example: `GET /filter/jobs/country/{country}`\n    \n\n### **Error Handling**\n\nThe API uses consistent error codes and messages to indicate issues with requests. Most errors will return a JSON response with the following structure:\n\n``` json\n{\n  \"message\": \"Error message explaining the issue\",\n  \"errors\": {\n    \"field_name\": [\"List of validation errors for this field\"]\n  }\n}\n\n ```\n\n#### **Common Error Codes**:\n\n- `400`: Bad Request\n    \n- `401`: Unauthorized (Invalid or missing authentication token)\n    \n- `404`: Resource not found\n    \n- `500`: Internal Server Error\n    \n\n#### 503 response\n\nAn HTTP `503` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP `5XX` error, [contact support](https://support@hirexpo.com).\n\n## **Contact and Support**\n\nIf you encounter any issues or have questions regarding the API, please reach out to our support team at `support@hirexpo.com`.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"37192852","team":6509485,"collectionId":"00a43713-331d-4a76-b2ab-48f3151406d4","publishedId":"2sAY4rFR32","public":true,"publicUrl":"https://documenter-api.postman.tech/view/37192852/2sAY4rFR32","privateUrl":"https://go.postman.co/documentation/37192852-00a43713-331d-4a76-b2ab-48f3151406d4","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FB8500"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Explore Hirexpo Dev API documentation for comprehensive guides and reference materials on our job platform. Enhance your hiring process with seamless API integration and detailed endpoints."},{"name":"title","value":"Developers - Hirexpo Dev API"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/8f3bba1c-f9e1-48cb-aa23-4a4bff6cdcdc/bG9nby5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FB8500"}},{"name":"light","logo":"https://content.pstmn.io/8f3bba1c-f9e1-48cb-aa23-4a4bff6cdcdc/bG9nby5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FB8500"}}]}},"version":"8.10.1","publishDate":"2024-10-29T05:41:12.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Developers - Hirexpo Dev API","description":"Explore Hirexpo Dev API documentation for comprehensive guides and reference materials on our job platform. Enhance your hiring process with seamless API integration and detailed endpoints."},"logos":{"logoLight":"https://content.pstmn.io/8f3bba1c-f9e1-48cb-aa23-4a4bff6cdcdc/bG9nby5wbmc=","logoDark":"https://content.pstmn.io/8f3bba1c-f9e1-48cb-aa23-4a4bff6cdcdc/bG9nby5wbmc="}},"statusCode":200},"environments":[{"name":"Production","id":"a0436b0d-7441-4eca-bad7-be1d15ca6ccb","owner":"37192852","values":[{"key":"token","value":"","type":"default","enabled":true},{"key":"collectionName","value":"","type":"default","enabled":true},{"key":"collectionSchemaUrl","value":"","type":"default","enabled":true},{"key":"accessKey","value":"","type":"default","enabled":true},{"key":"workspaceId","value":"","type":"default","enabled":true},{"key":"collectionId","value":"","type":"default","enabled":true}],"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/abe0b86a5468ca77ff4c811f5e351ad9015091434f3040512c8adb5bd9a82ce5","favicon":"https://res.cloudinary.com/postman/image/upload/v1730177934/team/870db2ac34e035d5bec397398b2a3722.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":"Production","value":"37192852-a0436b0d-7441-4eca-bad7-be1d15ca6ccb"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAY4rFR32"}