{"id":9316,"date":"2023-05-28T16:25:45","date_gmt":"2023-05-28T16:25:45","guid":{"rendered":"https:\/\/when2work.com\/help\/mgr\/?page_id=9316"},"modified":"2023-07-23T23:31:00","modified_gmt":"2023-07-23T23:31:00","slug":"api-setup","status":"publish","type":"page","link":"https:\/\/when2work.com\/help\/mgr\/api-setup\/","title":{"rendered":"API Setup &#038; Details &#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;\"><a href=\"https:\/\/when2work.com\/help\/mgr\/api-access\/\">About W2W API<\/a><\/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-key-options\/\">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><a href=\"https:\/\/when2work.com\/help\/mgr\/w2w-pro-plan\/\">Pro Plan<\/a> main managers can find an API <strong>Configure<\/strong> link on their <strong>Settings&gt; Pro<\/strong> page.<\/p>\n<p>Using that link they can enable API access for the account and set up options and copy endpoints.\u00a0\u00a0<\/p>\n<p>\n<\/p>\n<p>&nbsp;<\/p>\n<p><img class=\"aligncenter size-full wp-image-9394\" src=\"https:\/\/when2work.com\/help\/mgr\/wp-content\/uploads\/sites\/2\/2023\/05\/ss-api-enable.png\" alt=\"\" width=\"700\" height=\"609\" srcset=\"https:\/\/when2work.com\/help\/mgr\/wp-content\/uploads\/sites\/2\/2023\/05\/ss-api-enable.png 700w, https:\/\/when2work.com\/help\/mgr\/wp-content\/uploads\/sites\/2\/2023\/05\/ss-api-enable-300x261.png 300w\" sizes=\"(max-width: 700px) 100vw, 700px\" \/><\/p>\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","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 Pro Plan main&#8230;<\/p>\n<div class=\"more-link-wrapper\"><a class=\"more-link\" href=\"https:\/\/when2work.com\/help\/mgr\/api-setup\/\">More<span class=\"screen-reader-text\">API Setup &#038; Details &#8211; Pro Plan<\/span><\/a><\/div>\n","protected":false},"author":2,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"_links":{"self":[{"href":"https:\/\/when2work.com\/help\/mgr\/wp-json\/wp\/v2\/pages\/9316"}],"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\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/when2work.com\/help\/mgr\/wp-json\/wp\/v2\/comments?post=9316"}],"version-history":[{"count":36,"href":"https:\/\/when2work.com\/help\/mgr\/wp-json\/wp\/v2\/pages\/9316\/revisions"}],"predecessor-version":[{"id":9888,"href":"https:\/\/when2work.com\/help\/mgr\/wp-json\/wp\/v2\/pages\/9316\/revisions\/9888"}],"wp:attachment":[{"href":"https:\/\/when2work.com\/help\/mgr\/wp-json\/wp\/v2\/media?parent=9316"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}