{"article":{"id":115013356548,"url":"https://workable.zendesk.com/api/v2/help_center/en-us/articles/115013356548.json","html_url":"https://help.workable.com/hc/en-us/articles/115013356548-Workable-API-Documentation","author_id":23005911188,"comments_disabled":true,"draft":false,"promoted":true,"position":0,"vote_sum":12,"vote_count":26,"upvote_count":19,"downvote_count":7,"section_id":4903169507735,"created_at":"2017-10-10T18:19:29Z","updated_at":"2026-06-19T09:26:09Z","name":"Workable API Documentation","title":"Workable API Documentation","source_locale":"en-us","locale":"en-us","outdated":false,"outdated_locales":[],"edited_at":"2026-05-21T10:33:47Z","user_segment_id":null,"permission_group_id":1943354,"content_tag_ids":[],"label_names":["backend-account-integrations","webhook","web hook","all plans"],"body":"<p>To get started, view our full <a href=\"https://workable.readme.io/\" target=\"_blank\" rel=\"noopener noreferrer\"><strong>API documentation</strong></a><strong>. </strong>Depending on your needs with the Workable API, you can:</p><h3 id=\"h_01HBZK6QM618BFT1AJEJZEEGNY\">Extract information about your:</h3><ul>\n<li data-list-item-id=\"e160245951b9f587814d342f002b1a8b7\"><a href=\"https://workable.readme.io/reference/accounts\" target=\"_blank\" rel=\"noopener noreferrer\">account</a></li>\n<li data-list-item-id=\"ed22fcf3d5d84f84ddf0de125c4e5834d\">\n<a href=\"https://workable.readme.io/reference/members\" target=\"_blank\" rel=\"noopener noreferrer\">account members</a> and <a href=\"https://workable.readme.io/reference/recruiters\" target=\"_blank\" rel=\"noopener noreferrer\">recruiters</a>\n</li>\n<li data-list-item-id=\"e68e4aee7d30de0fe16748f5f60f9977e\">\n<a href=\"https://workable.readme.io/reference/stages\" target=\"_blank\" rel=\"noopener noreferrer\">pipeline stages</a> for each position</li>\n<li data-list-item-id=\"ef98946c53afe345c70050ce5356c1440\">\n<a href=\"https://workable.readme.io/reference/jobs\" target=\"_blank\" rel=\"noopener noreferrer\">jobs</a> and <a href=\"https://workable.readme.io/reference/job-questions\" target=\"_blank\" rel=\"noopener noreferrer\">application form questions</a>\n</li>\n<li data-list-item-id=\"e3ef5880b6233b1b21ac39a2b43ac01b0\">scheduled <a href=\"https://workable.readme.io/reference/events\" target=\"_blank\" rel=\"noopener noreferrer\">events</a>\n</li>\n<li data-list-item-id=\"e28947e2b512bc589ec76f0c8aba2dbbb\">\n<a href=\"https://workable.readme.io/reference/job-activities\" target=\"_blank\" rel=\"noopener noreferrer\">job's</a> and/or <a href=\"https://workable.readme.io/reference/candidate-activities\" target=\"_blank\" rel=\"noopener noreferrer\">candidate's</a> activity</li>\n<li data-list-item-id=\"e0e5de5250f595ba588bbab94c8f04dba\">\n<a href=\"https://workable.readme.io/reference/requisitions\" target=\"_blank\" rel=\"noopener noreferrer\">requisition data</a> (fields, approval status, and workflow)</li>\n</ul><h3 id=\"h_01HBZK7BWW6DFMAGT0GV6GYNJ8\">Manage your account by:</h3><ul>\n<li data-list-item-id=\"eb356a03ee1602fb494a203b5fe21bd2d\"><a href=\"https://workable.readme.io/reference/members-invite\" target=\"_blank\" rel=\"noopener noreferrer\">Inviting members</a></li>\n<li data-list-item-id=\"e78be190029dad88818b8d877f8df7036\"><a href=\"https://workable.readme.io/reference/members-put\" target=\"_blank\" rel=\"noopener noreferrer\">Updating member access level</a></li>\n<li data-list-item-id=\"eed820637dc118780d405fbcd69b6644e\">\n<a href=\"https://workable.readme.io/reference/members-delete\" target=\"_blank\" rel=\"noopener noreferrer\">Deactivating</a> or <a href=\"https://workable.readme.io/reference/members-enable\" target=\"_blank\" rel=\"noopener noreferrer\">restoring</a> members</li>\n<li data-list-item-id=\"e56617435de7dcd0cba09bf83f5221e01\">\n<a href=\"https://workable.readme.io/reference/departments-post\" target=\"_blank\" rel=\"noopener noreferrer\">Creating</a>, <a href=\"https://workable.readme.io/reference/departments-merge\" target=\"_blank\" rel=\"noopener noreferrer\">merging</a>, or <a href=\"https://workable.readme.io/reference/departments-delete\" target=\"_blank\" rel=\"noopener noreferrer\">deleting</a> departments</li>\n<li data-list-item-id=\"e694316b0213d0e7b3c0c6ef6f515eb8d\">\n<a href=\"https://workable.readme.io/reference/requisitions-post\" target=\"_blank\" rel=\"noopener noreferrer\">Creating</a>, <a href=\"https://workable.readme.io/reference/requisitions-patch\" target=\"_blank\" rel=\"noopener noreferrer\">updating</a>, <a href=\"https://workable.readme.io/reference/requisitions-approve\" target=\"_blank\" rel=\"noopener noreferrer\">approving</a>, or <a href=\"https://workable.readme.io/reference/requisitions-reject\" target=\"_blank\" rel=\"noopener noreferrer\">rejecting requisitions</a>\n</li>\n</ul><h3 id=\"01JKBEC0ZH3RJ2D5B5HVYPTAF1\">Manage your candidates by:</h3><ul>\n<li data-list-item-id=\"e1e7a790ef2effefa0641e17ece689723\">Fetching <a href=\"https://workable.readme.io/reference/job-candidates-index\" target=\"_blank\" rel=\"noopener noreferrer\">candidates</a>\n</li>\n<li data-list-item-id=\"ef56c7d2dd57c94377bb9579fc65cc3ff\">Extracting detailed <a href=\"https://workable.readme.io/reference/job-candidates-show\" target=\"_blank\" rel=\"noopener noreferrer\">candidate information</a>\n</li>\n<li data-list-item-id=\"e9bf0ca3f926c36b50d4a1f272ccbc2e1\">\n<a href=\"https://workable.readme.io/reference/job-candidates-create\" target=\"_blank\" rel=\"noopener noreferrer\">Creating candidate profiles</a> inside Workable</li>\n<li data-list-item-id=\"e48dfdb11fa6746ec410afc7f3f6f3f96\">\n<a href=\"https://workable.readme.io/reference/update-candidate\" target=\"_blank\" rel=\"noopener noreferrer\">Updating existing candidate profiles</a> (e.g. add comments, add/remove tags, disqualify/revert)</li>\n<li data-list-item-id=\"e9101f683fe45ae6f850adc3a5cdb9ddb\">Executing various actions on candidates e.g. <a href=\"https://workable.readme.io/docs/copy-candidate\" target=\"_blank\" rel=\"noopener noreferrer\">copy</a>, <a href=\"https://workable.readme.io/reference/relocate-candidates\" target=\"_blank\" rel=\"noopener noreferrer\">move</a> or <a href=\"https://workable.readme.io/reference/disqualify-candidate\" target=\"_blank\" rel=\"noopener noreferrer\">disqualify</a>\n</li>\n<li data-list-item-id=\"e33cf863104772a56d4754c6c176c77f4\">Adding <a href=\"https://workable.readme.io/reference/comment-on-candidate\" target=\"_blank\" rel=\"noopener noreferrer\">comments</a> or <a href=\"https://workable.readme.io/reference/rate-candidate\" target=\"_blank\" rel=\"noopener noreferrer\">ratings</a>\n</li>\n<li data-list-item-id=\"e9e080f5c899d278b25aa210586a59dfc\">Creating a <a href=\"https://workable.readme.io/reference/webhook-subscriptions-candidates-employees\" target=\"_blank\" rel=\"noopener noreferrer\">webhook</a> when a candidate is created or moved </li>\n</ul><h3 id=\"h_01HBZK7HBAHZCR7N17B75CZYE4\">Manage your employees by:</h3><ul>\n<li data-list-item-id=\"eb941ca77e6c1a73b4333288b55a6020d\">Listing your <a href=\"https://workable.readme.io/reference/employees\" target=\"_blank\" rel=\"noopener noreferrer\">employees</a>\n</li>\n<li data-list-item-id=\"e8c8a3144b5485a7fc786e23df6df97fc\">Getting information about a <a href=\"https://workable.readme.io/reference/employeesid\" target=\"_blank\" rel=\"noopener noreferrer\">specific employee</a>\n</li>\n<li data-list-item-id=\"e56c9353dd595aff26a825f1d8771b297\"><a href=\"https://workable.readme.io/reference/create-employee\" target=\"_blank\" rel=\"noopener noreferrer\">Creating a specific employee</a></li>\n<li data-list-item-id=\"ef900a6b7c173bddcf8d1d2695e6765c9\"><a href=\"https://workable.readme.io/reference/update-employee\" target=\"_blank\" rel=\"noopener noreferrer\">Updating a specific employee</a></li>\n<li data-list-item-id=\"eb4fa534c0307d7b3ca4d88e4ca36e97d\">\n<a href=\"https://workable.readme.io/reference/employeesiddocuments\" target=\"_blank\" rel=\"noopener noreferrer\">Getting documents</a> about a specific employee</li>\n<li data-list-item-id=\"e05bfa32b1c80940690a35f6951b60894\">\n<a href=\"https://workable.readme.io/reference/employeesiddocuments-1\" target=\"_blank\" rel=\"noopener noreferrer\">Creating documents</a> for a specific employee</li>\n</ul><h3 id=\"h_01HBZKS0Z1WBY01BAV001Z2TKZ\">Retrieve information about your account by:</h3><ul>\n<li data-list-item-id=\"e20e6fd19ae47e54d2627535f91960954\">Listing your <a href=\"https://workable.readme.io/reference/departments\" target=\"_blank\" rel=\"noopener noreferrer\">departments</a>\n</li>\n<li data-list-item-id=\"efee5f75816e3007bdd6ae213942ffa78\">Listing your <a href=\"https://workable.readme.io/reference/work_schedules\" target=\"_blank\" rel=\"noopener noreferrer\">work schedules</a>\n</li>\n<li data-list-item-id=\"e6d9d4cd0669508d9d7aad5faa733608a\">Listing your <a href=\"https://workable.readme.io/reference/employee_fields\" target=\"_blank\" rel=\"noopener noreferrer\">employee fields</a>\n</li>\n<li data-list-item-id=\"e7d122c47ffaddce0f545d6a2b9068697\">Listing your configured <a href=\"https://workable.readme.io/reference/legal_entities\" target=\"_blank\" rel=\"noopener noreferrer\">legal entities</a>\n</li>\n</ul><h3 id=\"h_manage_time_tracking\">Manage time tracking by:</h3><ul>\n<li data-list-item-id=\"effdb4121d999e816e78ea7fc7b80e239\">\n<a href=\"https://workable.readme.io/reference/time-tracking-list-entries\" target=\"_blank\" rel=\"noopener noreferrer\">Retrieving time entries</a> per employee and date range</li>\n<li data-list-item-id=\"e6446e17a3bb81b66a0c412ff96e28ce7\">\n<a href=\"https://workable.readme.io/reference/time-tracking-bulk-create\" target=\"_blank\" rel=\"noopener noreferrer\">Creating time entries</a> from external systems (clock-in/out events)</li>\n<li data-list-item-id=\"e8f1aece4111b0ad070bd5a41c9562418\">\n<a href=\"https://workable.readme.io/reference/time-tracking-update-entry\" target=\"_blank\" rel=\"noopener noreferrer\">Updating or correcting</a> existing time entries</li>\n<li data-list-item-id=\"e733a018cbd10e6e93efba77621aab177\">\n<a href=\"https://workable.readme.io/reference/time-tracking-archive-entry\" target=\"_blank\" rel=\"noopener noreferrer\">Deleting</a> existing time entries</li>\n</ul><h3 id=\"h_01HBZK7VHAT42DJHFJTF2TXSR7\">Create custom reports: </h3><ul>\n<li data-list-item-id=\"e2ca78fb0ecff477990da3928c26a63ca\">Get the job or candidate activity stream</li>\n<li data-list-item-id=\"e9eb964465c0933db880b153461704a1c\">Process data outside of Workable and build a report</li>\n</ul><h3 id=\"h_01HBZK83F04K34MJGT7AWMYDBV\"><span class=\"fabric-text-color-mark\" data-renderer-mark=\"true\" data-text-custom-color=\"#000000\">Export new hires to another system:</span></h3><ul>\n<li data-list-item-id=\"e5982aabee0c3be09bb65cd4c4727d846\">Periodically get a list of candidates from Workable in the \"Hired\" stage and use the candidate endpoint to get the full profile information or</li>\n<li data-list-item-id=\"e8922e714981a3fd5ad0e56d64c3b4dcf\">Create webhook subscriptions to automatically receive data when candidates move to the Hired stage and use the candidate endpoint to get the full profile information.</li>\n</ul><p> </p><h2 id=\"h_01HBZBD9Y3KQ5DH4RFN7VHV15K\">FAQs</h2><dl class=\"accordion\">\n<dt>Is there a limitation on requests?</dt>\n<dd><p>Yes, it is 10 requests per 10 seconds. If you reach the limit, you will be getting the error 429; in this case, review your implementation and control the requests when the error appears.</p></dd>\n</dl><dl class=\"accordion\">\n<dt>Is it possible to access custom questions or custom fields via the API?</dt>\n<dd>\n<p>Yes! You can retrieve a list of associated application questions for a job from the <em>/jobs/:shortcode/questions</em> endpoint. Custom fields (both candidate and user-provided) for a specific job can be retrieved from the <em>/jobs/:shortcode/custom_attributes</em> endpoint. </p>\n<p>Answers to custom questions and custom fields (both candidate and user-provided) are included in the response of the call to <em>/candidates/:id </em>(under the 'answers' key).</p>\n</dd>\n</dl><dl class=\"accordion\">\n<dt>Where can I submit suggestions for API documentation updates?</dt>\n<dd>\n<p>If you see anything missing or unclear in our API documentation, please add your comment while voting if the article was helpful.</p>\n<p class=\"wysiwyg-text-align-center\"><img src=\"https://help.workable.com/hc/article_attachments/8418018000663\" alt=\"mceclip0.png\"></p>\n<p> </p>\n</dd>\n</dl><p>👉 <strong>Next steps</strong>: <a href=\"https://help.workable.com/hc/en-us/articles/115015785428\" target=\"_blank\" rel=\"noopener noreferrer\">Generating/revoking an access token for Workable's API</a></p>","user_segment_ids":[]}}