
{"id":1271,"date":"2018-05-09T01:30:27","date_gmt":"2018-05-09T01:30:27","guid":{"rendered":"https:\/\/when2work.com\/help\/mgr\/?page_id=1271"},"modified":"2023-07-23T23:22:31","modified_gmt":"2023-07-23T23:22:31","slug":"api-access","status":"publish","type":"page","link":"https:\/\/when2work.com\/help\/mgr\/api-access\/","title":{"rendered":"API (application programming interface) &#8211; Pro Plan"},"content":{"rendered":"<div class=\"inforight\">\n<h4 style=\"text-align: center;\"><strong>Documentation Links<\/strong><\/h4>\n<ul>\n<li style=\"text-align: left;\"><strong><a href=\"https:\/\/when2work.com\/help\/mgr\/api-access\/\">About W2W API<\/a><\/strong><\/li>\n<li style=\"text-align: left;\"><a href=\"https:\/\/when2work.com\/help\/mgr\/api-setup\/\">API Setup<\/a><\/li>\n<li style=\"text-align: left;\"><a href=\"https:\/\/when2work.com\/help\/mgr\/api-general-endpoints\/\">Key &amp; Options<\/a><\/li>\n<li style=\"text-align: left;\"><a href=\"https:\/\/when2work.com\/help\/mgr\/api-3rdpartyexports\/\">Preconfigured Third Party Programs<\/a><\/li>\n<li style=\"text-align: left;\"><a href=\"https:\/\/when2work.com\/help\/mgr\/api-general-endpoints\/\">General Endpoints<\/a><\/li>\n<li style=\"text-align: left;\"><a href=\"https:\/\/when2work.com\/help\/mgr\/api-calls\/\">API Calls<\/a><\/li>\n<li style=\"text-align: left;\"><a href=\"https:\/\/when2work.com\/help\/mgr\/api-power-bi\/\">Use with Power BI<\/a><\/li>\n<\/ul>\n<\/div>\n<p>WhenToWork offers many manual <a href=\"https:\/\/when2work.com\/help\/mgr\/third-party-exports-list-of-programs\/\">custom exports<\/a> and <a href=\"https:\/\/when2work.com\/help\/mgr\/reports-third-party\/\">third party file exports<\/a> when logged into an active session and the export option is chosen.<\/p>\n<p><a style=\"border-top-color: #a5d3ed; border-right-color: #a5d3ed; border-left-color: #a5d3ed; outline: none;\" href=\"https:\/\/when2work.com\/help\/mgr\/wp-content\/uploads\/sites\/2\/2023\/04\/w2wpro.png\"><img class=\"wp-image-9234 alignleft\" src=\"https:\/\/when2work.com\/help\/mgr\/wp-content\/uploads\/sites\/2\/2023\/04\/w2wpro.png\" alt=\"\" width=\"137\" height=\"143\" \/><\/a><\/p>\n<p><a href=\"https:\/\/when2work.com\/help\/mgr\/w2w-pro-plan\/\"><strong>Pro Plan<\/strong><\/a> subscribers can also use our <strong>Read Only API<\/strong> to automate data extraction from their account to be used with other systems.\u00a0<\/p>\n<p>&nbsp;<\/p>\n<h3>\u00a0<\/h3>\n<h3>Notes:<\/h3>\n<p>&#8211; If you choose to enable API access, make sure you keep your key private.\u00a0 Anyone who has access to the key can access your data.<\/p>\n<p>&#8211; We recommend limiting access to specific IPs when possible.<\/p>\n<p>&#8211; The API will accept either GET or POST commands, and treats them both the same.\u00a0 The results are in JSON format.<\/p>\n<p>&#8211; * The key and all parameters may be included in form post data or on the URL (the least safe option).\u00a0 The key may also be passed in the http header.<\/p>\n<p>&#8211; Any calls that take START_DATE and END_DATE (Shift List, Time Off, Daily Totals, etc.) are limited to 31 days of data. Any requests over 31 days will be rejected.<\/p>\n<p>&#8211; Any calls that fetch shift information can take an optional parameter POSITION=(position id) to filter the results to the specified position.<\/p>\n<hr \/>\n<h3>Non Pro Plan users<\/h3>\n<p>Can use our <a href=\"https:\/\/when2work.com\/help\/mgr\/h-sub-printouts\/h-google\/\">Export to Google Calendar<\/a> feature to export data and then retrieve data from there. Employees can export their schedules and managers can set up to automatically send all or part of the schedule to Google Calendar. Google Calendar can then be a source for a constant, automated export.<\/p>\n<p>&nbsp;<\/p>\n<p>&nbsp;<\/p>\n<p><span class=\"extrawords\">Application programming interface rss feed &#8211; RSS Feed Access?<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Documentation Links About W2W API API Setup Key &amp; Options Preconfigured Third Party Programs General Endpoints API Calls Use with Power BI WhenToWork offers many&#8230;<\/p>\n<div class=\"more-link-wrapper\"><a class=\"more-link\" href=\"https:\/\/when2work.com\/help\/mgr\/api-access\/\">More<span class=\"screen-reader-text\">API (application programming interface) &#8211; Pro Plan<\/span><\/a><\/div>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":29,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"_links":{"self":[{"href":"https:\/\/when2work.com\/help\/mgr\/wp-json\/wp\/v2\/pages\/1271"}],"collection":[{"href":"https:\/\/when2work.com\/help\/mgr\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/when2work.com\/help\/mgr\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/when2work.com\/help\/mgr\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/when2work.com\/help\/mgr\/wp-json\/wp\/v2\/comments?post=1271"}],"version-history":[{"count":37,"href":"https:\/\/when2work.com\/help\/mgr\/wp-json\/wp\/v2\/pages\/1271\/revisions"}],"predecessor-version":[{"id":9883,"href":"https:\/\/when2work.com\/help\/mgr\/wp-json\/wp\/v2\/pages\/1271\/revisions\/9883"}],"wp:attachment":[{"href":"https:\/\/when2work.com\/help\/mgr\/wp-json\/wp\/v2\/media?parent=1271"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}