{"__v":6,"_id":"576832cebb15f40e00a288e2","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[]},"settings":"","url":""},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"OnboardIQ API v2.0 Overview\"\n}\n[/block]\nOnboardIQ implements a simple REST API to help you programmatically manage your applicants, assign and remove labels, manage available slots, and perform the booking or canceling the booking of slots.\n\nThis document assumes that you are familiar with an idea of REST API and have some experience with tools like curl or an HTTP client library for your favorite programming language. If you’re not comfortable with that much technical information, just contact our support and we will try to figure out a way to integrate your product with OnboardIQ.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Tokens and Authentication\"\n}\n[/block]\n## Private API Key\nYou can find your api_token by logging into your OnboardIQ dashboard. Click on your account name in the top-right corner, and then select “API”. Click the \"Show API Key\" button to see your keys.\n\nTo authenticate a request, pass your API token in the `X-ACCESS-TOKEN` request header, or in the `api_token` parameter.\n\n## Public API Key\n\nTo simplify data import from 3rd party sources (such as sourcing/staffing agencies), we offer a Public API Key. A Public API Key can be used only to access a single method, \"Create an applicant.\"\n\nThis way, you can share your Public API Key with a 3rd party service to import applicants into your pipeline with no worries that a 3rd party could gain access to any sensitive data.\n\nNote that using a default API key with the Create an applicant method works as well.\n\n\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"API Methods\"\n}\n[/block]\nPlease check out the documentation for any API method you are interested in.\n\nThe Web version of our API documentation features a live tool to test the method on the fly and generates a curl command as well — for you to try in the comfort of your cozy command line.\n\nA detailed scheme for both the method request and response is provided as well.\n\n## Unique Identifiers\n\nMost OnboardIQ entities — applicants, stages, slots — have a unique global identifier (UUID), sometimes referred to as just “ID”. Use that unique identifier to find an entity that you require — for example, you need to provide a unique applicant identifier to get his/her profile info, background check report status, label status, and etc.\n\nWe recommend storing UUIDs of OnboardIQ entities in your database to use them later when you start working with the API. For example, once you create an applicant via the API, the response will feature the UUID of that applicant; you can save it to your database and later use our GET methods to retrieve up-to-date info on the applicant and also make updates.","category":"576832cebb15f40e00a288d2","createdAt":"2016-02-19T00:12:36.851Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"547505a059fade080004cb8f","slug":"overview","sync_unique":"","title":"Overview","type":"basic","updates":["5834295b1a80690f00d31eed","58342dcc4c5f192f00c9d4cc","585293f988b5e82f00748076"],"user":"547504ed59fade080004cb8b","version":"576832cebb15f40e00a288d1","childrenPages":[]}
[block:api-header] { "type": "basic", "title": "OnboardIQ API v2.0 Overview" } [/block] OnboardIQ implements a simple REST API to help you programmatically manage your applicants, assign and remove labels, manage available slots, and perform the booking or canceling the booking of slots. This document assumes that you are familiar with an idea of REST API and have some experience with tools like curl or an HTTP client library for your favorite programming language. If you’re not comfortable with that much technical information, just contact our support and we will try to figure out a way to integrate your product with OnboardIQ. [block:api-header] { "type": "basic", "title": "Tokens and Authentication" } [/block] ## Private API Key You can find your api_token by logging into your OnboardIQ dashboard. Click on your account name in the top-right corner, and then select “API”. Click the "Show API Key" button to see your keys. To authenticate a request, pass your API token in the `X-ACCESS-TOKEN` request header, or in the `api_token` parameter. ## Public API Key To simplify data import from 3rd party sources (such as sourcing/staffing agencies), we offer a Public API Key. A Public API Key can be used only to access a single method, "Create an applicant." This way, you can share your Public API Key with a 3rd party service to import applicants into your pipeline with no worries that a 3rd party could gain access to any sensitive data. Note that using a default API key with the Create an applicant method works as well. [block:api-header] { "type": "basic", "title": "API Methods" } [/block] Please check out the documentation for any API method you are interested in. The Web version of our API documentation features a live tool to test the method on the fly and generates a curl command as well — for you to try in the comfort of your cozy command line. A detailed scheme for both the method request and response is provided as well. ## Unique Identifiers Most OnboardIQ entities — applicants, stages, slots — have a unique global identifier (UUID), sometimes referred to as just “ID”. Use that unique identifier to find an entity that you require — for example, you need to provide a unique applicant identifier to get his/her profile info, background check report status, label status, and etc. We recommend storing UUIDs of OnboardIQ entities in your database to use them later when you start working with the API. For example, once you create an applicant via the API, the response will feature the UUID of that applicant; you can save it to your database and later use our GET methods to retrieve up-to-date info on the applicant and also make updates.