{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e44099dd-6647-4b78-bd7a-03293e47dee5","name":"Embloy-API Collection","description":"Welcome to our Postman Collection! Here you can find and test all public Embloy-API endpoints using Postman.\n\n# Common Error Codes\n\n| Error | Description | Solution |\n| --- | --- | --- |\n| 400 Bad Request | Our server could not understand the request due to invalid syntax. | Ensure all required fields are correctly filled. |\n| 401 Unauthorized | The request requires user authentication. | Verify your access token is valid and included in the request headers (see [RFC 6750: Bearer Token](https://www.rfc-editor.org/rfc/rfc6750)). |\n| 403 Forbidden | You do not have permission to access the requested resource. | Check your user permissions and API scopes. The action you performed might require a subscription. |\n| 404 Not Found | The requested resource could not be found. | Ensure the endpoint URL and resource ID are correct. |\n| 409 Conflict | The request could not be completed due to a conflict with the current state of the target resource. | Resolve the conflict before retrying the request (e.g., you already applied to a job or are trying to reject an already rejected application). |\n| 429 Too Many Requests / Unprocessable Entity | You have exhausted the limit of a resource given your current subscription or trying to persist more entites than allowed. | Make sure that you have a valid subscription and don't have surpassed its usage limits (e.g., trying to create more jobs than your subscription allows or applying for the same job twice). |\n| 500 Internal Server Error | Our server encountered an unexpected condition that prevented it from fulfilling the request. | Try again later or check [status.embloy.com](https://status.embloy.com).  <br>If the issue persists, please contact our support. |\n| 503 Service Unavailable | The server is currently unable to handle the request due to maintenance or you probably have sent too many requests in a given amount of time (\"rate limiting\"). | Try again later or reduce the frequency of requests. |\n\n# Getting Started\n\n## Step 1: Fork the collection using Run in Postman\n\n[<img src=\"https://run.pstmn.io/button.svg\">](https://god.gw.postman.com/run-collection/24977803-e44099dd-6647-4b78-bd7a-03293e47dee5?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D24977803-e44099dd-6647-4b78-bd7a-03293e47dee5%26entityType%3Dcollection%26workspaceId%3D6b47d1cc-f4b3-4522-8ab1-98a55f18324c)\n\n## Step 2 (method 1): Create a new access token automatically\n\n1. Sign into our [recruiter portal](https://genius.embloy.com) or [create a new Embloy account](https://embloy.com/register)\n    \n2. Create a new access token by going to the \"secrets\" tab of your [Embloy Genius settings](https://genius.embloy.com/settings?tab=secrets) and pressing on the \"create access token\" button and save it to the `access_token` variable in Postman\n    \n\n## Step 2 (method 2): Get your access token manually\n\n#### If you don't have an account yet:\n\n1. Create new user `POST:/user`\n    \n2. Verify user `GET:/user/verify`\n    \n3. Activate account using the link sent to your email\n    \n4. Request new refresh token via `POST:/user/auth/token/refresh` using your credentials\n    \n5. Save the JWT you received in the variable `refresh_token`\n    \n6. Request new access token with `POST:/user/auth/token/access`\n    \n7. Save access token to variable `access_token`\n    \n\n#### Else, sign in with existing account:\n\n1. Request new refresh token via `POST:/user/auth/token/refresh` using your credentials\n    \n2. Save the JWT you received in the variable `refresh_token`\n    \n3. Request new access token with `POST:/user/auth/token/access`\n    \n4. Save access token to variable `access_token`\n    \n\n## Step 3: Make your first API call\n\nEmbloy recommends starting with the Jobs and Quicklink APIs. These steps will use the Jobs and Quicklink APIs to create a job and capture applications using [sandbox accounts](https://developers.embloy.com/docs/core/subscriptions/subscription_features) linked to your Developer Dashboard account.\n\nTo create a job:\n\n1. In your workspace, navigate to your fork of the Embloy collection.\n    \n2. Select **Jobs > Create job**.\n    \n3. Select the **Send** button to create the job. On a successful call, the API returns a `201 Created` response code.\n    \n\nTo upload an application:\n\n1. In **User > Get user's jobs**, find the `id` of the job you created.\n    \n2. In the **Variables** tab, enter it into the `job_id` field.\n    \n3. Select **Applications > Submit application**.\n    \n4. Select **Send**. On a successful call, the API returns a `201 Created` code.\n    \n\nYour job has been created and an application has been captured. You can review the submitted application in the [Embloy Genius dashboard](https://genius.embloy.com/recruitment).\n\n# Debugging\n\nYou might encounter some of the following errors when using unauthorized access tokens:\n\n> **NOTE:** _Find out more about our access tokens and scopes in our_ [&lt;em&gt;developer docs&lt;/em&gt;](https://developers.embloy.com/docs/core/tokens/token_info#access-token)_._ \n  \n\n| Scope | Error | Description | Solution |\n| --- | --- | --- | --- |\n| user | 400: ERR_INVALID | Attribute cannot be retrieved. | Ensure the attribute name is correct and the attribute exists. |\n| token | 400: ERR_INVALID | Attribute is invalid or expired. | Verify the token's validity and ensure it has not expired. |\n| token | 403: ERR_RAC | The scope 'genius.embloy.com/api.write' is not allowed because it does not match the application's base URL. | Check that the scope matches the application's base URL. |\n| token | 403: ERR_RAC | The requested path '/integrations/auth/xyz' is not allowed for scope 'api.embloy.com/api.write'. | Ensure the requested path is correct and within the allowed scope. |\n| token | 403: ERR_RAC | The scope 'api.embloy.com/api.read' is not allowed to perform the 'PATCH' method. | Verify that the scope has the correct permissions for the desired HTTP method. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"24977803","team":5710144,"collectionId":"e44099dd-6647-4b78-bd7a-03293e47dee5","publishedId":"2s9YRB2rkE","public":true,"publicUrl":"https://docs.embloy.com","privateUrl":"https://go.postman.co/documentation/24977803-e44099dd-6647-4b78-bd7a-03293e47dee5","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"8a5fd5"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Do you want to connect your ATS to Embloy or  plan to build an integration solution manually? - here you will find detailed information about our API."},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"99ffff"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"8a5fd5"}}]}},"version":"8.11.4","publishDate":"2024-05-26T15:14:25.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"Do you want to connect your ATS to Embloy or  plan to build an integration solution manually? - here you will find detailed information about our API."},"logos":{"logoLight":null,"logoDark":null}},"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/69cdc88f25aa78f9ec8188ce639c62425089a0141c702baa739c3471e00203ce","favicon":"https://embloy.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://docs.embloy.com/view/metadata/2s9YRB2rkE"}