The Ento API allows you to interact with Ento programmatically. Use the API to send and retrieve data between your business-critical systems and Ento, to maximise the synchronicity of your company's data using the highest standards of data security.
\nThe Ento API is organised around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
\nNot a developer? Use add-ons from our partners to get started with Ento and to do more with Ento.
\nPlease contact Ento Support to enable API access.
\nYou will be provided with a secret API key that can be used to integrate with the Ento API. This key is specific to your account and should not be shared with anybody.
\nThe Ento API uses API keys to authenticate requests.
\nYour API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
\nEnto expects for the API key to be included in all API requests to the server in a header that looks like the following:
\nx-api-key: APIKEY
You must replace APIKEY with your API key.
The Ento API uses the following error codes:
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Enabling the Ento API","slug":"enabling-the-ento-api"},{"content":"Authentication","slug":"authentication"},{"content":"Errors","slug":"errors"}],"owner":"8172058","collectionId":"c28c67f5-5900-46ff-b617-a53572af8e20","publishedId":"SVSLqoXe","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"11B3C0"},"publishDate":"2019-07-26T06:30:52.000Z"},"item":[{"name":"Employees","item":[{"name":"An employee","id":"f1a6139a-6cdf-4f3c-98cd-fa1d53bfc2ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":""},{"key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"url":"https://api.ento.com/au/api/employees/2941","description":"Retrieve a single employee's data.
\n","urlObject":{"protocol":"https","path":["au","api","employees","2941"],"host":["api","ento","com"],"query":[],"variable":[]}},"response":[{"id":"614ea718-3bd2-4e23-a1dc-16b18311eccd","name":"A Employee","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"fXugriT1Ko7MquQAA4QAO8C6xxNKnEga71hwyCzc"},{"key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"url":"https://api.ento.com/au/api/employees/1234"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"1234\",\n \"attributes\": {\n \"externalid\": \"ST10002\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"jsmith@example.com\",\n \"email_notify\": true,\n \"mobile\": null,\n \"mobile_notify\": true,\n \"baserate\": \"10.000\",\n \"standard_hours\": \"40.00\",\n \"gender\": \"Undisclosed\",\n \"dob\": {\n \"date\": \"2018-03-21 00:00:00.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"UTC\"\n },\n \"notes\": \"\",\n \"commencement_date\": \"2018-03-13\",\n \"termination_date\": null,\n \"status\": \"active\"\n },\n \"relationships\": {\n \"permission\": {\n \"data\": {\n \"type\": \"employee_permissions\",\n \"id\": \"371\"\n }\n },\n \"award\": {\n \"data\": {\n \"type\": \"awards\",\n \"id\": \"732\"\n }\n },\n \"paycycle\": {\n \"data\": {\n \"type\": \"paycycles\",\n \"id\": \"482\"\n }\n },\n \"work_schedule\": {\n \"data\": {\n \"type\": \"work_schedules\",\n \"id\": \"5437\"\n }\n },\n \"primary_role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10984\"\n }\n },\n \"primary_area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3171\"\n }\n }\n }\n }\n}"}],"_postman_id":"f1a6139a-6cdf-4f3c-98cd-fa1d53bfc2ce"},{"name":"Employees","id":"577958db-f09c-41af-ac84-0e9c12c4c994","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":""},{"key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"url":"https://api.ento.com/au/api/employees","description":"This resource will return all employees associated with your company by default. Additional parameters can be passed in the request to act as filters:
\nStatus: active / pre-start
\nStart date: yyyy-mm-dd format
\nFirst name
\nLast name
\nRetrieve all employees with a matching first name.
\n","urlObject":{"protocol":"https","path":["au","api","employees"],"host":["api","ento","com"],"query":[{"key":"filter[first_name]","value":"john"},{"key":"filter[last_name]","value":"doe"}],"variable":[]}},"response":[{"id":"2c13b067-5e72-47c3-9920-91efaff51e22","name":"Employees filtered by Name","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"fXugriT1Ko7MquQAA4QAO8C6xxNKnEga71hwyCzc"},{"key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"url":{"raw":"https://api.ento.com/au/api/employees?filter[first_name]=john","protocol":"https","host":["api","ento","com"],"path":["au","api","employees"],"query":[{"key":"filter[first_name]","value":"john"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"employees\",\n \"id\": \"2946\",\n \"attributes\": {\n \"externalid\": \"ST10007\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"jsmith@example.com\",\n \"email_notify\": true,\n \"mobile\": null,\n \"mobile_notify\": true,\n \"baserate\": \"0.000\",\n \"standard_hours\": \"0.00\",\n \"gender\": \"Undisclosed\",\n \"dob\": null,\n \"notes\": null,\n \"commencement_date\": \"2018-03-23\",\n \"termination_date\": null,\n \"status\": \"pre-start\"\n },\n \"relationships\": {\n \"permission\": {\n \"data\": {\n \"type\": \"employee_permissions\",\n \"id\": \"371\"\n }\n },\n \"award\": {\n \"data\": {\n \"type\": \"awards\",\n \"id\": \"731\"\n }\n },\n \"paycycle\": {\n \"data\": {\n \"type\": \"paycycles\",\n \"id\": \"482\"\n }\n },\n \"work_schedule\": {\n \"data\": {\n \"type\": \"work_schedules\",\n \"id\": \"5437\"\n }\n },\n \"primary_role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10984\"\n }\n },\n \"primary_area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3171\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"api/employees?filter[first_name]=John&page[number]=1&page[size]=100\",\n \"last\": \"api/employees?filter[first_name]=John&page[number]=1&page[size]=100\",\n \"self\": \"api/employees?filter[first_name]=John&page[number]=1&page[size]=100\"\n }\n}"}],"_postman_id":"b4429148-5b07-43c1-b9c6-5dbdb1ca3af6"}],"id":"81d0a3fd-2914-4937-8e10-1fec468e3798","description":"The Employee GET methods allows you to retrieve information about your company's employees.
Retrieve a single shift.
\n","urlObject":{"protocol":"https","path":["au","api","shifts","79909"],"host":["api","ento","com"],"query":[],"variable":[]}},"response":[{"id":"85b11621-62b2-4159-9ba2-ae1c4c36effc","name":"A Shift","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"fXugriT1Ko7MquQAA4QAO8C6xxNKnEga71hwyCzc"},{"key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"url":"https://api.ento.com/au/api/shifts/79909"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"shifts\",\n \"id\": \"79909\",\n \"attributes\": {\n \"date\": \"2019-01-21\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-21 09:00:00\",\n \"end\": \"2019-01-21 17:00:00\",\n \"status\": \"Processed\",\n \"break_length\": 60,\n \"break_start\": \"2019-01-21 13:00:00\",\n \"break_end\": \"2019-01-21 14:00:00\",\n \"cost\": \"70.00\",\n \"hours\": \"7.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2948\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n }\n}"}],"_postman_id":"39e32bac-5217-454d-8963-107d1e9b1e20"},{"name":"A shift with an employee and role","id":"96aa7e2f-bafd-486a-90c5-11b61553bcbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":""},{"key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"url":"https://api.ento.com/au/api/shifts/79909?included=employee,role","description":"Retrieve a single shift with employee and role data included.
\n","urlObject":{"protocol":"https","path":["au","api","shifts","79909"],"host":["api","ento","com"],"query":[{"key":"included","value":"employee,role"}],"variable":[]}},"response":[{"id":"5e125134-b8f3-4ca7-add1-8597f90b310c","name":"A Shift with Employee and Role","originalRequest":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"fXugriT1Ko7MquQAA4QAO8C6xxNKnEga71hwyCzc"},{"key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"url":{"raw":"https://api.ento.com/au/api/shifts/79909?included=employee,role","protocol":"https","host":["api","ento","com"],"path":["au","api","shifts","79909"],"query":[{"key":"included","value":"employee,role"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"shifts\",\n \"id\": \"79909\",\n \"attributes\": {\n \"date\": \"2019-01-21\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-21 09:00:00\",\n \"end\": \"2019-01-21 17:00:00\",\n \"status\": \"Processed\",\n \"break_length\": 60,\n \"break_start\": \"2019-01-21 13:00:00\",\n \"break_end\": \"2019-01-21 14:00:00\",\n \"cost\": \"70.00\",\n \"hours\": \"7.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2948\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n \"included\": [\n {\n \"type\": \"employees\",\n \"id\": \"2948\",\n \"attributes\": {\n \"externalid\": \"ST10008\",\n \"first_name\": \"Mark\",\n \"last_name\": \"mark\",\n \"email\": \"aulay@example\",\n \"email_notify\": true,\n \"mobile\": null,\n \"mobile_notify\": true,\n \"baserate\": \"10.000\",\n \"standard_hours\": \"38.01\",\n \"gender\": \"Undisclosed\",\n \"dob\": null,\n \"notes\": \"\",\n \"commencement_date\": \"2017-04-11\",\n \"termination_date\": null,\n \"status\": \"active\"\n },\n \"relationships\": {\n \"permission\": {\n \"data\": {\n \"type\": \"employee_permissions\",\n \"id\": \"376\"\n }\n },\n \"award\": {\n \"data\": {\n \"type\": \"awards\",\n \"id\": \"732\"\n }\n },\n \"paycycle\": {\n \"data\": {\n \"type\": \"paycycles\",\n \"id\": \"482\"\n }\n },\n \"work_schedule\": {\n \"data\": {\n \"type\": \"work_schedules\",\n \"id\": \"5437\"\n }\n },\n \"primary_role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"primary_area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"roles\",\n \"id\": \"10987\",\n \"attributes\": {\n \"externalid\": \"RO10002\",\n \"name\": \"volunteer\"\n }\n }\n ]\n}"}],"_postman_id":"96aa7e2f-bafd-486a-90c5-11b61553bcbd"},{"name":"Shifts between a date range","id":"9d777d08-658b-4f84-b44a-f6ae3c10e75c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":""},{"key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"url":"https://api.ento.com/au/api/shifts?filter[start_date]=2019-01-06&filter[end_date]=2019-06-08","description":"This resource will return all shifts associated with your company. The following parameters are required:
\nstart_date
\nend_date
\nAdditional parameters can be passed in the request to act as filters:
\narea_id
\nrole_id
\nemployee_id
\nThis resource will return all shifts associated with your company and use pagination.
\n","urlObject":{"protocol":"https","path":["au","api","shifts"],"host":["api","ento","com"],"query":[{"key":"filter[start_date]","value":"2019-01-06"},{"key":"filter[end_date]","value":"2019-06-08"},{"key":"page[size]","value":"25"}],"variable":[]}},"response":[{"id":"354ff4a7-3ebf-4cf2-8bc1-a0c594d45bf9","name":"Shifts with Pagination","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"fXugriT1Ko7MquQAA4QAO8C6xxNKnEga71hwyCzc","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.ento.com/au/api/shifts?filter[start_date]=2019-01-06&filter[end_date]=2019-06-08&page[size]=25","protocol":"https","host":["api","ento","com"],"path":["au","api","shifts"],"query":[{"key":"filter[start_date]","value":"2019-01-06"},{"key":"filter[end_date]","value":"2019-06-08"},{"key":"page[size]","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"shifts\",\n \"id\": \"79909\",\n \"attributes\": {\n \"date\": \"2019-01-21\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-21 09:00:00\",\n \"end\": \"2019-01-21 17:00:00\",\n \"status\": \"Processed\",\n \"break_length\": 60,\n \"break_start\": \"2019-01-21 13:00:00\",\n \"break_end\": \"2019-01-21 14:00:00\",\n \"cost\": \"70.00\",\n \"hours\": \"7.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2948\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79910\",\n \"attributes\": {\n \"date\": \"2019-01-22\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-22 09:00:00\",\n \"end\": \"2019-01-22 17:00:00\",\n \"status\": \"Processed\",\n \"break_length\": 60,\n \"break_start\": \"2019-01-22 13:00:00\",\n \"break_end\": \"2019-01-22 14:00:00\",\n \"cost\": \"70.00\",\n \"hours\": \"7.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2948\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79912\",\n \"attributes\": {\n \"date\": \"2019-01-25\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-25 09:00:00\",\n \"end\": \"2019-01-25 17:00:00\",\n \"status\": \"Processed\",\n \"break_length\": 60,\n \"break_start\": \"2019-01-25 13:00:00\",\n \"break_end\": \"2019-01-25 14:00:00\",\n \"cost\": \"70.00\",\n \"hours\": \"7.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2948\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79913\",\n \"attributes\": {\n \"date\": \"2019-01-24\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-24 09:00:00\",\n \"end\": \"2019-01-24 17:00:00\",\n \"status\": \"Processed\",\n \"break_length\": 60,\n \"break_start\": \"2019-01-24 12:30:00\",\n \"break_end\": \"2019-01-24 13:30:00\",\n \"cost\": \"70.00\",\n \"hours\": \"7.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2948\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79914\",\n \"attributes\": {\n \"date\": \"2019-01-26\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-26 09:00:00\",\n \"end\": \"2019-01-26 17:00:00\",\n \"status\": \"Processed\",\n \"break_length\": 60,\n \"break_start\": \"2019-01-26 13:00:00\",\n \"break_end\": \"2019-01-26 14:00:00\",\n \"cost\": \"70.00\",\n \"hours\": \"7.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2948\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79915\",\n \"attributes\": {\n \"date\": \"2019-01-28\",\n \"label\": \"9:00am-10:00am\",\n \"start\": \"2019-01-28 09:00:00\",\n \"end\": \"2019-01-28 10:00:00\",\n \"status\": \"Published\",\n \"break_length\": 15,\n \"break_start\": \"2019-01-28 09:30:00\",\n \"break_end\": \"2019-01-28 09:45:00\",\n \"cost\": \"7.50\",\n \"hours\": \"0.75\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2948\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79916\",\n \"attributes\": {\n \"date\": \"2019-01-27\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-27 09:00:00\",\n \"end\": \"2019-01-27 17:00:00\",\n \"status\": \"Processed\",\n \"break_length\": 60,\n \"break_start\": \"2019-01-27 13:00:00\",\n \"break_end\": \"2019-01-27 14:00:00\",\n \"cost\": \"70.00\",\n \"hours\": \"7.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2948\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79918\",\n \"attributes\": {\n \"date\": \"2019-01-31\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-31 09:00:00\",\n \"end\": \"2019-01-31 17:00:00\",\n \"status\": \"Published\",\n \"break_length\": 60,\n \"break_start\": \"2019-01-31 13:00:00\",\n \"break_end\": \"2019-01-31 14:00:00\",\n \"cost\": \"70.00\",\n \"hours\": \"7.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2948\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79919\",\n \"attributes\": {\n \"date\": \"2019-02-02\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-02-02 09:00:00\",\n \"end\": \"2019-02-02 17:00:00\",\n \"status\": \"Published\",\n \"break_length\": 60,\n \"break_start\": \"2019-02-02 13:00:00\",\n \"break_end\": \"2019-02-02 14:00:00\",\n \"cost\": \"70.00\",\n \"hours\": \"7.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2948\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79920\",\n \"attributes\": {\n \"date\": \"2019-02-03\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-02-03 09:00:00\",\n \"end\": \"2019-02-03 17:00:00\",\n \"status\": \"Published\",\n \"break_length\": 60,\n \"break_start\": \"2019-02-03 13:00:00\",\n \"break_end\": \"2019-02-03 14:00:00\",\n \"cost\": \"70.00\",\n \"hours\": \"7.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2948\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79922\",\n \"attributes\": {\n \"date\": \"2019-01-29\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-29 09:00:00\",\n \"end\": \"2019-01-29 17:00:00\",\n \"status\": \"Published\",\n \"break_length\": 0,\n \"break_start\": null,\n \"break_end\": null,\n \"cost\": \"80.00\",\n \"hours\": \"8.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2948\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79923\",\n \"attributes\": {\n \"date\": \"2019-01-21\",\n \"label\": \"9:00am-5:30pm\",\n \"start\": \"2019-01-21 09:00:00\",\n \"end\": \"2019-01-21 17:30:00\",\n \"status\": \"Published\",\n \"break_length\": 30,\n \"break_start\": \"2019-01-21 13:15:00\",\n \"break_end\": \"2019-01-21 13:45:00\",\n \"cost\": \"0.00\",\n \"hours\": \"8.00\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10984\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3171\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79924\",\n \"attributes\": {\n \"date\": \"2019-01-21\",\n \"label\": \"9:00am-5:30pm\",\n \"start\": \"2019-01-21 09:00:00\",\n \"end\": \"2019-01-21 17:30:00\",\n \"status\": \"Processed\",\n \"break_length\": 30,\n \"break_start\": \"2019-01-21 13:00:00\",\n \"break_end\": \"2019-01-21 13:30:00\",\n \"cost\": \"80.00\",\n \"hours\": \"8.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2945\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10984\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3171\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79925\",\n \"attributes\": {\n \"date\": \"2019-01-21\",\n \"label\": \"9:00am-5:30pm\",\n \"start\": \"2019-01-21 09:00:00\",\n \"end\": \"2019-01-21 17:30:00\",\n \"status\": \"Processed\",\n \"break_length\": 30,\n \"break_start\": \"2019-01-21 13:15:00\",\n \"break_end\": \"2019-01-21 13:45:00\",\n \"cost\": \"800.00\",\n \"hours\": \"8.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2943\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10984\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3171\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79926\",\n \"attributes\": {\n \"date\": \"2019-01-21\",\n \"label\": \"9:00am-5:30pm\",\n \"start\": \"2019-01-21 09:00:00\",\n \"end\": \"2019-01-21 17:30:00\",\n \"status\": \"Processed\",\n \"break_length\": 30,\n \"break_start\": \"2019-01-21 13:15:00\",\n \"break_end\": \"2019-01-21 13:45:00\",\n \"cost\": \"80.00\",\n \"hours\": \"8.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2941\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10984\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3171\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79927\",\n \"attributes\": {\n \"date\": \"2019-01-21\",\n \"label\": \"9:00am-5:30pm\",\n \"start\": \"2019-01-21 09:00:00\",\n \"end\": \"2019-01-21 17:30:00\",\n \"status\": \"Processed\",\n \"break_length\": 30,\n \"break_start\": \"2019-01-21 13:15:00\",\n \"break_end\": \"2019-01-21 13:45:00\",\n \"cost\": \"80.00\",\n \"hours\": \"8.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2942\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10984\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3171\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79928\",\n \"attributes\": {\n \"date\": \"2019-01-21\",\n \"label\": \"9:00am-5:30pm\",\n \"start\": \"2019-01-21 09:00:00\",\n \"end\": \"2019-01-21 17:30:00\",\n \"status\": \"Processed\",\n \"break_length\": 30,\n \"break_start\": \"2019-01-21 13:15:00\",\n \"break_end\": \"2019-01-21 13:45:00\",\n \"cost\": \"800.00\",\n \"hours\": \"8.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2940\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10984\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3171\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79941\",\n \"attributes\": {\n \"date\": \"2019-01-23\",\n \"label\": \"Shift Test\",\n \"start\": \"2019-01-23 07:00:00\",\n \"end\": \"2019-01-23 16:00:00\",\n \"status\": \"Processed\",\n \"break_length\": 60,\n \"break_start\": \"2019-01-23 12:00:00\",\n \"break_end\": \"2019-01-23 13:00:00\",\n \"cost\": \"800.00\",\n \"hours\": \"8.00\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2943\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10984\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3171\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79946\",\n \"attributes\": {\n \"date\": \"2019-01-22\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-22 09:00:00\",\n \"end\": \"2019-01-22 17:00:00\",\n \"status\": \"Published\",\n \"break_length\": 30,\n \"break_start\": \"2019-01-22 13:00:00\",\n \"break_end\": \"2019-01-22 13:30:00\",\n \"cost\": \"0.00\",\n \"hours\": \"7.50\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10984\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3171\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"79975\",\n \"attributes\": {\n \"date\": \"2019-01-30\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-30 09:00:00\",\n \"end\": \"2019-01-30 17:00:00\",\n \"status\": \"Published\",\n \"break_length\": 30,\n \"break_start\": \"2019-01-30 13:00:00\",\n \"break_end\": \"2019-01-30 13:30:00\",\n \"cost\": \"0.00\",\n \"hours\": \"7.50\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10984\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3171\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"81616\",\n \"attributes\": {\n \"date\": \"2019-01-06\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-06 09:00:00\",\n \"end\": \"2019-01-06 17:00:00\",\n \"status\": \"Published\",\n \"break_length\": 30,\n \"break_start\": \"2019-01-06 13:00:00\",\n \"break_end\": \"2019-01-06 13:30:00\",\n \"cost\": \"0.00\",\n \"hours\": \"7.50\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"81617\",\n \"attributes\": {\n \"date\": \"2019-01-06\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-06 09:00:00\",\n \"end\": \"2019-01-06 17:00:00\",\n \"status\": \"Published\",\n \"break_length\": 30,\n \"break_start\": \"2019-01-06 13:00:00\",\n \"break_end\": \"2019-01-06 13:30:00\",\n \"cost\": \"750.00\",\n \"hours\": \"7.50\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2943\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"81618\",\n \"attributes\": {\n \"date\": \"2019-01-06\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-06 09:00:00\",\n \"end\": \"2019-01-06 17:00:00\",\n \"status\": \"Published\",\n \"break_length\": 30,\n \"break_start\": \"2019-01-06 13:00:00\",\n \"break_end\": \"2019-01-06 13:30:00\",\n \"cost\": \"75.00\",\n \"hours\": \"7.50\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2948\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"81619\",\n \"attributes\": {\n \"date\": \"2019-01-06\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-06 09:00:00\",\n \"end\": \"2019-01-06 17:00:00\",\n \"status\": \"Published\",\n \"break_length\": 30,\n \"break_start\": \"2019-01-06 13:00:00\",\n \"break_end\": \"2019-01-06 13:30:00\",\n \"cost\": \"75.00\",\n \"hours\": \"7.50\"\n },\n \"relationships\": {\n \"employee\": {\n \"data\": {\n \"type\": \"employees\",\n \"id\": \"2942\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n },\n {\n \"type\": \"shifts\",\n \"id\": \"81620\",\n \"attributes\": {\n \"date\": \"2019-01-06\",\n \"label\": \"9:00am-5:00pm\",\n \"start\": \"2019-01-06 09:00:00\",\n \"end\": \"2019-01-06 17:00:00\",\n \"status\": \"Published\",\n \"break_length\": 30,\n \"break_start\": \"2019-01-06 13:00:00\",\n \"break_end\": \"2019-01-06 13:30:00\",\n \"cost\": \"0.00\",\n \"hours\": \"7.50\"\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"10987\"\n }\n },\n \"area\": {\n \"data\": {\n \"type\": \"areas\",\n \"id\": \"3173\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"next\": \"/api/shifts?filter[end_date]=2019-06-08&filter[start_date]=2019-01-06&page[number]=2&page[size]=25\",\n \"prev\": \"\",\n \"first\": \"/api/shifts?filter[end_date]=2019-06-08&filter[start_date]=2019-01-06&page[number]=1&page[size]=25\",\n \"last\": \"/api/shifts?filter[end_date]=2019-06-08&filter[start_date]=2019-01-06&page[number]=7211&page[size]=25\",\n \"self\": \"/api/shifts?filter[end_date]=2019-06-08&filter[start_date]=2019-01-06&page[number]=1&page[size]=25\"\n }\n}"}],"_postman_id":"572ef604-aae7-48fd-b9ad-44c8dc8508f6"}],"id":"49b34709-057c-4a28-ada1-af908e5745a3","description":"The Shift GET methods allows you to retrieve information about your company's shifts.
This resource will return all unavailabilities associated with your company. The following parameters are required:
\nAdditional parameters can be passed in the request to act as filters:
\nThe Unavailabilities GET methods allows you to retrieve information about your company's unavailabilities within a specific period.