{"info":{"_postman_id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","name":"Workfeed API (prod)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"11154454","collectionId":"59bfbd79-56b8-4afc-ba02-aaa84928a576","publishedId":"2s93eR3v2K","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2f67ff"},"publishDate":"2024-03-01T19:29:17.000Z"},"item":[{"name":"Shifts","item":[{"name":"Create shift","id":"da24097a-1a79-409b-b2b7-a589b12f314c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"roleID\": \"roleID\",\n \"start\": \"2023-05-18T14:00:00.000Z\",\n \"end\": \"2023-05-19T02:00:00.000Z\",\n \"employeeID\": null,\n \"released\": true,\n \"comment\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/shifts","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Required	Description	Type / Format	Example
`roleID`	Yes	GET your Roles here	`string`	`hLbEKIPTlMh3ehotXl0w`
`start`	Yes	When Shift starts	an ISO 8601 encoded `string`	`2023-05-18T14:00:00.000Z`
`end`	Yes	When shift ends	an ISO 8601 encoded `string`	`2023-05-19T02:00:00.000Z`
`employeeID`	Yes	GET your Employees here	`string` / `null`	`j1TznpqVtLN0nmgPfK476U5fn2O2`
`released`	Yes	if Shift was released (Published)	`boolean`	`true`
`comment`	Yes	Shift comments	`string` / `null`	`null`
`tagIDs`	No	Shift tags	`string[]`	`[\"tagID_1\", \"tagID_2\"]`

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
id	Created Shift Id	`string`	`InOzjxrVqOjtIpqyTfF4`

","urlObject":{"path":["companies","COMPANY_ID","shifts"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[]}},"response":[{"id":"0b310116-b43d-48ae-a9e6-dd834a6a6a65","name":"Create shift","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"roleID\": \"hLbEKIPTlMh3ehotXl0w\",\n \"start\": \"2023-05-18T14:00:00.000Z\",\n \"end\": \"2023-05-19T02:00:00.000Z\",\n \"employeeID\": null,\n \"released\": true,\n \"comment\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/shifts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"InOzjxrVqOjtIpqyTfF4\"\n}"}],"_postman_id":"da24097a-1a79-409b-b2b7-a589b12f314c"},{"name":"Get shifts","id":"0807785c-d41e-4b2d-b4c4-72fb8968ffcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/shifts?startFrom=2023-05-01T00:00:00.000Z&startTo=2023-05-07T00:00:00.000Z","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Required	Description	Type / format	Example
`startFrom`	Yes	Only get shifts starting on or after this time	an ISO 8601 encoded `string`	`2022-04-07T22:00:00.000Z`
`startTo`	Yes	Only get shifts starting before this time	an ISO 8601 encoded `string`	`2022-04-10T22:00:00.000Z`
`employeeID`	No	If present, only get shifts of the employee with this id	`string`	`j1TznpqVtLN0nmgPfK476U5fn2O2`
`released`	No	If present, only get released (if `true`) or unreleased (if `false`) shifts	`boolean`	`true`

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / format	Example
id	Shift ID	`string`	`Trcu7MKFomu5y5zv1B8G`
start	When Shift starts	an ISO 8601 encoded `string`	`2023-10-23T08:00:00.000Z`
end	When Shift ends	an ISO 8601 encoded `string`	`2023-10-23T16:00:00.000Z`
employeeID	Employee associated to the Shift	`string` / `null`	`null`
roleID	Role associated with the Shift	`string`	`hLbEKIPTlMh3ehotXl0w`
departmentID	Department associated with the Shift	`string`	`PKHaOSgFA4uguOqmLfWv`
released	If Shift was released	`boolean`	`false`
isForSale	if Shift is for sale	`boolean`	`false`
comment	Shift comments	`object` / `null`
comment.message	Comment Text	`string`	`Comments! 😍`
comment.creatorID	How was this comment created, via UI or API	`string`	`API`
comment.createdOn	When comment was created	an ISO 8601 encoded `string`	`2023-10-27T09:43:36.542Z`
customBreak	Employee Break for example \"Lunch Break\"	`object` / `null`	`null`
customBreak.creatorID	If it was created by the Employee or automatically	`string` / `\"automatic\"`	`null`
customBreak.duration	Break duration in Hours	`number`	`1`
customBreak.createdOn	When Break was created	an ISO 8601 encoded `string`	`2023-10-27T09:10:30.336Z`
overlappingLeaveID	If there is a Leave overlapping the Shift, for example a Vacation, Parental leave, etc...	`string` / `null`	`null`
approval	Shift Approval	`object` / `null`	`null`
approval.approver	`EmployeeID` / `\"automatic\"`	`string`	`automatic`
approval.date	Shift Date	an ISO 8601 encoded `string`	`2023-12-27T09:10:30.336Z`
approval.originalStart	Shift Original Start Date	an ISO 8601 encoded `string`	`2023-12-07T09:10:30.336Z`
approval.originalEnd	Shift Original End Date	an ISO 8601 encoded `string`	`2023-12-08T09:10:30.336Z`
grossPay	Shift Salary. If `employeeID` is null, this value will not be calculated and return `null` Note: While grossPay has been rigorously tested, its accuracy in some unique cases might vary. We welcome feedback to enhance its precision.	`number` / `null`	`null`
`tagIDs`	Shift tags	`string[]`	`[\"tagID_1\", \"tagID_2\"]`
createTime	When Shift was created	an ISO 8601 encoded `string`	`2023-10-27T09:10:30.336Z`
updateTime	When Shift was updated	an ISO 8601 encoded `string`	`2023-10-27T09:10:30.336Z`

","urlObject":{"path":["companies","COMPANY_ID","shifts"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[{"description":{"content":"

Only get shifts starting on or after this time

\n","type":"text/plain"},"key":"startFrom","value":"2023-05-01T00:00:00.000Z"},{"description":{"content":"

Only get shifts starting before this time

\n","type":"text/plain"},"key":"startTo","value":"2023-05-07T00:00:00.000Z"},{"disabled":true,"description":{"content":"

If present, only get shifts of the employee with this id

\n","type":"text/plain"},"key":"employeeID","value":"89nzICSt3oZJWhTeco6AmO958Bz1"},{"disabled":true,"description":{"content":"

If present, only get released (if true) or unreleased (if false) shifts

\n","type":"text/plain"},"key":"released","value":"true"}],"variable":[]}},"response":[{"id":"503e46b7-121c-4031-ab5e-a184c8184466","name":"Get shifts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/shifts?startFrom=2023-05-01T00:00:00.000Z&startTo=2023-10-30T00:00:00.000Z","protocol":"https","host":["europe-west1-production-eu-327a3","cloudfunctions","net"],"path":["api","companies","COMPANY_ID","shifts"],"query":[{"key":"employeeID","value":"89nzICSt3oZJWhTeco6AmO958Bz1","disabled":true},{"key":"released","value":"true","disabled":true},{"key":"startFrom","value":"2023-05-01T00:00:00.000Z"},{"key":"startTo","value":"2023-10-30T00:00:00.000Z"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"Trcu7MKFomu5y5zv1B8G\",\n \"start\": \"2023-10-23T08:00:00.000Z\",\n \"end\": \"2023-10-23T16:00:00.000Z\",\n \"employeeID\": null,\n \"roleID\": \"hLbEKIPTlMh3ehotXl0w\",\n \"departmentID\": \"PKHaOSgFA4uguOqmLfWv\",\n \"released\": false,\n \"isForSale\": false,\n \"comment\": null,\n \"customBreak\": null,\n \"overlappingLeaveID\": null,\n \"approval\": null,\n \"grossPay\": null,\n \"createTime\": \"2023-10-27T09:10:30.336Z\",\n \"updateTime\": \"2023-10-27T09:10:30.422Z\"\n }\n]"}],"_postman_id":"0807785c-d41e-4b2d-b4c4-72fb8968ffcd"},{"name":"Get shift","id":"1e09229b-602c-40c2-9b2f-eb169d17f9ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/shifts/:shiftID","description":"

Response Fields

Body	Description	Type / format	Example
id	Shift ID	`string`	`Trcu7MKFomu5y5zv1B8G`
start	When Shift starts	an ISO 8601 encoded `string`	`2023-10-23T08:00:00.000Z`
end	When Shift ends	an ISO 8601 encoded `string`	`2023-10-23T16:00:00.000Z`
employeeID	Employee associated to the Shift	`string` / `null`	`null`
roleID	Role associated with the Shift	`string`	`hLbEKIPTlMh3ehotXl0w`
departmentID	Department associated with the Shift	`string`	`PKHaOSgFA4uguOqmLfWv`
released	If Shift was released	`boolean`	`false`
isForSale	if Shift is for sale	`boolean`	`false`
comment	Shift comments	`object` / `null`
comment.message	Comment Text	`string`	`Comments! 😍`
comment.creatorID	How was this comment created, via UI or API	`string`	`API`
comment.createdOn	When comment was created	an ISO 8601 encoded `string`	`2023-10-27T09:43:36.542Z`
customBreak	Employee Break for example \"Lunch Break\"	`object` / `null`	`null`
customBreak.creatorID	If it was created by the Employee or automatically	`string` / `\"automatic\"`	`null`
customBreak.duration	Break duration in Hours	`number`	`1`
customBreak.createdOn	When Break was created	an ISO 8601 encoded `string`	`2023-10-27T09:10:30.336Z`
overlappingLeaveID	If there is a Leave overlapping the Shift, for example a Vacation, Parental leave, etc...	`string` / `null`	`null`
approval	Shift Approval	`object` / `null`	`null`
approval.approver	`EmployeeID` / `\"automatic\"`	`string`	`automatic`
approval.date	Shift Date	an ISO 8601 encoded `string`	`2023-12-27T09:10:30.336Z`
approval.originalStart	Shift Original Start Date	an ISO 8601 encoded `string`	`2023-12-07T09:10:30.336Z`
approval.originalEnd	Shift Original End Date	an ISO 8601 encoded `string`	`2023-12-08T09:10:30.336Z`
grossPay	Shift Salary. If `employeeID` is null, this value will not be calculated and return `null` Note: While grossPay has been rigorously tested, its accuracy in some unique cases might vary. We welcome feedback to enhance its precision.	`number` / `null`	`null`
`tagIDs`	Shift tags	`string[]`	`[\"tagID_1\", \"tagID_2\"]`
createTime	When Shift was created	an ISO 8601 encoded `string`	`2023-10-27T09:10:30.336Z`
updateTime	When Shift was updated	an ISO 8601 encoded `string`	`2023-10-27T09:10:30.336Z`

","urlObject":{"path":["companies","COMPANY_ID","shifts",":shiftID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"description":{"content":"

Shift ID

\n","type":"text/plain"},"type":"any","value":"","key":"shiftID"}]}},"response":[{"id":"98f13a09-b32d-49f9-935c-9071ebcfbcbd","name":"Get shift","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/shifts/Trcu7MKFomu5y5zv1B8G"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"Trcu7MKFomu5y5zv1B8G\",\n \"start\": \"2023-10-23T08:00:00.000Z\",\n \"end\": \"2023-10-23T16:00:00.000Z\",\n \"employeeID\": null,\n \"roleID\": \"hLbEKIPTlMh3ehotXl0w\",\n \"departmentID\": \"PKHaOSgFA4uguOqmLfWv\",\n \"released\": false,\n \"isForSale\": false,\n \"comment\": null,\n \"customBreak\": null,\n \"overlappingLeaveID\": null,\n \"approval\": null,\n \"grossPay\": null,\n \"createTime\": \"2023-10-27T09:10:30.336Z\",\n \"updateTime\": \"2023-10-27T09:10:30.422Z\"\n}"}],"_postman_id":"1e09229b-602c-40c2-9b2f-eb169d17f9ec"},{"name":"Update shift","id":"4f040678-cf6e-49bd-8e60-fe326f839cf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"start\": \"2023-05-04T19:30:00.000Z\",\n \"end\": \"2023-05-05T02:00:00.000Z\",\n \"employeeID\": \"c6gzyUOTsof8xGUBwJhKZ6l0Pwi1\",\n \"roleID\": \"lkADAqIEiefMkhwkdmeL\",\n \"released\": true,\n \"comment\": \"Comments! 😍\"\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/shifts/:shiftID","description":"

NOTE: You cannot change the date of a shift

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Required	Description	Type / Format	Example
`roleID`	No	Role ID associated to the Shift	`string`	`hLbEKIPTlMh3ehotXl0w`
`start`	No	When Shift starts	an ISO 8601 encoded `string`	`2023-05-18T14:00:00.000Z`
`end`	No	When Shift ends	an ISO 8601 encoded `string`	`2023-05-19T02:00:00.000Z`
`employeeID`	No	Employee ID associated to the Shift	`boolean` / `null`	`null`
`released`	No	If Shift was released	`boolean`	`true`
`comment`	No	Shift comments	`string` / `null`	`Comments! 😍`
`tagIDs`	No	Shift tags	`string[]`	`[\"tagID_1\", \"tagID_2\"]`

Response Fields

Body	Description	Type / Format	Example
id	Shift Id	`string`	`Trcu7MKFomu5y5zv1B8G`
start	When Shift starts	an ISO 8601 encoded `string`	`2023-10-23T08:00:00.000Z`
end	When Shift ends	an ISO 8601 encoded `string`	`2023-10-23T16:00:00.000Z`
employeeID	Employee ID associated to the Shift	`string` / `null`	`null`
roleID	Role ID associated to the Shift	`string`	`hLbEKIPTlMh3ehotXl0w`
departmentID	Department ID associated to the Shift	`string`	`PKHaOSgFA4uguOqmLfWv`
released	If Shift was released	`boolean`	`true`
isForSale	if Shift is for sale	`boolean`	`false`
comment	Shift comments	`object`
comment.message	Comment Text	`string`	`Comments! 😍`
comment.creatorID	How was this comment created, via UI or API	`string`	`API`
comment.createdOn	When comment was created	an ISO 8601 encoded `string`	`2023-10-27T09:43:36.542Z`
customBreak	Employee Break for example \"Lunch Break\"	`object` / `null`	`null`
customBreak.creatorID	If it was created by the Employee or automatically	`string` / `\"automatic\"`	`null`
customBreak.duration	Break duration in Hours	`number`	`1`
customBreak.createdOn	When Break was created	an ISO 8601 encoded `string`	`2023-10-27T09:10:30.336Z`
overlappingLeaveID	If there is a Leave overlapping the Shift, for example a Vacation, Parental leave, etc...	`string` / `null`	`null`
approval	Shift Approval	`object` / `null`	`null`
approval.approver	`EmployeeID` / `\"automatic\"`	`string`	`automatic`
approval.date	Shift Date	an ISO 8601 encoded `string`	`2023-12-27T09:10:30.336Z`
approval.originalStart	Shift Original Start Date	an ISO 8601 encoded `string`	`2023-12-07T09:10:30.336Z`
approval.originalEnd	Shift Original End Date	an ISO 8601 encoded `string`	`2023-12-08T09:10:30.336Z`
grossPay	Shift Salary. If `employeeID` is null, this value will not be calculated and return `null` Note: While grossPay has been rigorously tested, its accuracy in some unique cases might vary. We welcome feedback to enhance its precision.	`number` / `null`	`null`
`tagIDs`	Shift tags	`string[]`	`[\"tagID_1\", \"tagID_2\"]`
createTime	When Shift was created	an ISO 8601 encoded `string`	`2023-10-27T09:10:30.336Z`
updateTime	When Shift was updated	an ISO 8601 encoded `string`	`2023-10-27T09:43:36.597Z`

","urlObject":{"path":["companies","COMPANY_ID","shifts",":shiftID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"id":"30f73282-f123-468d-9a07-d9159664a22d","description":{"content":"

Shift ID

\n","type":"text/plain"},"type":"any","value":"","key":"shiftID"}]}},"response":[{"id":"4ed9f299-c390-4683-87e4-0c17ee890cf4","name":"Update shift","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"employeeID\": null,\n \"roleID\": \"hLbEKIPTlMh3ehotXl0w\",\n \"start\": \"2023-05-18T14:00:00.000Z\",\n \"end\": \"2023-05-19T02:00:00.000Z\",\n \"released\": true,\n \"comment\": \"Comments! 😍\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/shifts/:shiftID","protocol":"https","host":["europe-west1-production-eu-327a3","cloudfunctions","net"],"path":["api","companies","COMPANY_ID","shifts",":shiftID"],"variable":[{"key":"shiftID","value":"Trcu7MKFomu5y5zv1B8G"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"Trcu7MKFomu5y5zv1B8G\",\n \"start\": \"2023-10-23T08:00:00.000Z\",\n \"end\": \"2023-10-23T16:00:00.000Z\",\n \"employeeID\": null,\n \"roleID\": \"hLbEKIPTlMh3ehotXl0w\",\n \"departmentID\": \"PKHaOSgFA4uguOqmLfWv\",\n \"released\": true,\n \"isForSale\": false,\n \"comment\": {\n \"message\": \"Comments! 😍\",\n \"creatorID\": \"API\",\n \"createdOn\": \"2023-10-27T09:43:36.542Z\"\n },\n \"customBreak\": null,\n \"overlappingLeaveID\": null,\n \"approval\": null,\n \"grossPay\": null,\n \"createTime\": \"2023-10-27T09:10:30.336Z\",\n \"updateTime\": \"2023-10-27T09:43:36.597Z\"\n}"}],"_postman_id":"4f040678-cf6e-49bd-8e60-fe326f839cf9"},{"name":"Delete shift","id":"41ef151d-e929-4a74-99b1-9e861552afc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/shifts/:shiftID","urlObject":{"path":["companies","COMPANY_ID","shifts",":shiftID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"id":"765efd63-e5d0-466c-a9fc-c6a157ef24e6","description":{"content":"

Shift ID

\n","type":"text/plain"},"type":"any","value":"","key":"shiftID"}]}},"response":[{"id":"58174a57-6f4b-4f5d-86c0-bfbd73a2a98c","name":"Delete shift","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/shifts/:shiftID","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","shifts",":shiftID"],"variable":[{"key":"shiftID","value":"Trcu7MKFomu5y5zv1B8G"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"41ef151d-e929-4a74-99b1-9e861552afc6"}],"id":"0db7d7f2-0504-41ee-8e6e-d0895c8fbc77","_postman_id":"0db7d7f2-0504-41ee-8e6e-d0895c8fbc77","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","name":"Workfeed API (prod)","type":"collection"}}},{"name":"Tags","item":[{"name":"Create tag","id":"c12c3692-1198-4e82-a578-34aa3d450c39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Tag Name\",\n \"color\": \"#E9379D\"\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/tags","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
`name`	Name of the tag	`string`	`Cool tag name!`
`color`	Color of the tag	One of the supported colors from this list: \"#85909F\", \"#3D7AFF\", \"#5FD0C8\", \"#6DABC0\", \"#5A992C\", \"#07BE62\", \"#555ACF\", \"#8824BC\", \"#A35BD8\", \"#E9379D\", \"#EC4D3D\", \"#F19D9B\", \"#FF8000\", \"#F7CD45\", \"#7E4F19\"	`#85909F`

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
`id`	Created tag id	`string`	`4FfT87ZfNpOj5aP4E4N3`

","urlObject":{"path":["companies","COMPANY_ID","tags"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[]}},"response":[{"id":"6f6e069f-65b7-4d6a-98e6-d6ce8edcccdb","name":"Create tag","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Tag Name\",\n \"color\": \"#E9379D\"\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"4FfT87ZfNpOj5aP4E4N3\"\n}"}],"_postman_id":"c12c3692-1198-4e82-a578-34aa3d450c39"},{"name":"Get tags","id":"c6b48b40-b173-453f-8201-4cef641cdcc5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/tags","description":"

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / format	Example
`id`	Tag ID	`string`	`4FfT87ZfNpOj5aP4E4N3`
`name`	Name of the tag	`string`	`Cool tag name!`
`color`	Color of the tag	One of the supported colors from this list: \"#85909F\", \"#3D7AFF\", \"#5FD0C8\", \"#6DABC0\", \"#5A992C\", \"#07BE62\", \"#555ACF\", \"#8824BC\", \"#A35BD8\", \"#E9379D\", \"#EC4D3D\", \"#F19D9B\", \"#FF8000\", \"#F7CD45\", \"#7E4F19\"	`\"#F7CD45\"`
`deletedOn`	When the tag was soft-deleted or `null` if not deleted	an ISO 8601 encoded `string` / `null`	`null`
`createTime`	When the tag was created	an ISO 8601 encoded `string`	`\"2026-01-01T00:00:00.000Z\"`
`updateTime`	When the tag was updated	an ISO 8601 encoded `string`	`\"2026-01-01T00:00:00.000Z\"`

","urlObject":{"path":["companies","COMPANY_ID","tags"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[]}},"response":[{"id":"b14cbe4b-8c70-48e5-b715-c40e6dae1168","name":"Get tags","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"4FfT87ZfNpOj5aP4E4N3\",\n \"name\": \"Tag Name\",\n \"color\": \"#E9379D\",\n \"deletedOn\": null,\n \"createTime\": \"2026-01-01T00:00:00.000Z\",\n \"updateTime\": \"2026-01-01T00:00:00.000Z\"\n }\n]"}],"_postman_id":"c6b48b40-b173-453f-8201-4cef641cdcc5"},{"name":"Get tag","id":"a861b925-c8ed-475a-87c1-9ca0727e6725","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/tags/:tagID","description":"

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / format	Example
`id`	Tag ID	`string`	`4FfT87ZfNpOj5aP4E4N3`
`name`	Name of the tag	`string`	`Cool tag name!`
`color`	Color of the tag	One of the supported colors from this list: \"#85909F\", \"#3D7AFF\", \"#5FD0C8\", \"#6DABC0\", \"#5A992C\", \"#07BE62\", \"#555ACF\", \"#8824BC\", \"#A35BD8\", \"#E9379D\", \"#EC4D3D\", \"#F19D9B\", \"#FF8000\", \"#F7CD45\", \"#7E4F19\"	`\"#F7CD45\"`
`deletedOn`	When the tag was soft-deleted or `null` if not deleted	an ISO 8601 encoded `string` / `null`	`null`
`createTime`	When the tag was created	an ISO 8601 encoded `string`	`\"2026-01-01T00:00:00.000Z\"`
`updateTime`	When the tag was updated	an ISO 8601 encoded `string`	`\"2026-01-01T00:00:00.000Z\"`

","urlObject":{"path":["companies","COMPANY_ID","tags",":tagID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"type":"any","value":"","key":"tagID"}]}},"response":[{"id":"e7176ccb-4809-4249-9beb-20d9164ff986","name":"Get tag","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/tags/4FfT87ZfNpOj5aP4E4N3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"4FfT87ZfNpOj5aP4E4N3\",\n \"name\": \"Tag Name\",\n \"color\": \"#E9379D\",\n \"deletedOn\": null,\n \"createTime\": \"2026-01-01T00:00:00.000Z\",\n \"updateTime\": \"2026-01-01T00:00:00.000Z\"\n}"}],"_postman_id":"a861b925-c8ed-475a-87c1-9ca0727e6725"},{"name":"Update tag","id":"8b4229a2-cf41-4cb2-9ec0-fd371e7869dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Updated Tag Name\",\n \"color\": \"#F7CD45\"\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/tag/:tagID","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Required?	Description	Type / Format	Example
`name`	No	Name of the tag	`string`	`Cool tag name!`
`color`	No	Color of the tag	One of the supported colors from this list: \"#85909F\", \"#3D7AFF\", \"#5FD0C8\", \"#6DABC0\", \"#5A992C\", \"#07BE62\", \"#555ACF\", \"#8824BC\", \"#A35BD8\", \"#E9379D\", \"#EC4D3D\", \"#F19D9B\", \"#FF8000\", \"#F7CD45\", \"#7E4F19\"	`#85909F`

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / format	Example
`id`	Tag ID	`string`	`4FfT87ZfNpOj5aP4E4N3`
`name`	Name of the tag	`string`	`Cool tag name!`
`color`	Color of the tag	One of the supported colors from this list: \"#85909F\", \"#3D7AFF\", \"#5FD0C8\", \"#6DABC0\", \"#5A992C\", \"#07BE62\", \"#555ACF\", \"#8824BC\", \"#A35BD8\", \"#E9379D\", \"#EC4D3D\", \"#F19D9B\", \"#FF8000\", \"#F7CD45\", \"#7E4F19\"	`\"#F7CD45\"`
`deletedOn`	When the tag was soft-deleted or `null` if not deleted	an ISO 8601 encoded `string` / `null`	`null`
`createTime`	When the tag was created	an ISO 8601 encoded `string`	`\"2026-01-01T00:00:00.000Z\"`
`updateTime`	When the tag was updated	an ISO 8601 encoded `string`	`\"2026-01-01T00:00:00.000Z\"`

","urlObject":{"path":["companies","COMPANY_ID","tag",":tagID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"type":"any","value":"","key":"tagID"}]}},"response":[{"id":"791f3b1f-2dab-4395-a8c2-f9c5e3f2ac4e","name":"Update tag","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Updated Tag Name\",\n \"color\": \"#F7CD45\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/tags/:tagID","protocol":"https","host":["europe-west1-production-eu-327a3","cloudfunctions","net"],"path":["api","companies","COMPANY_ID","tags",":tagID"],"variable":[{"key":"tagID","value":"4FfT87ZfNpOj5aP4E4N3"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"4FfT87ZfNpOj5aP4E4N3\",\n \"name\": \"Updated Tag Name\",\n \"color\": \"#F7CD45\",\n \"deletedOn\": null,\n \"createTime\": \"2026-01-01T00:00:00.000Z\",\n \"updateTime\": \"2026-01-01T00:00:00.000Z\"\n}"}],"_postman_id":"8b4229a2-cf41-4cb2-9ec0-fd371e7869dd"},{"name":"Delete tag","id":"806a8544-8630-43b1-8687-a89f85ec7c3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/tags/:tagID","urlObject":{"path":["companies","COMPANY_ID","tags",":tagID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"type":"any","value":"","key":"tagID"}]}},"response":[{"id":"9a586ae8-a9cc-400b-83e1-27495469db80","name":"Delete tag","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/tags/:tagID","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","tags",":tagID"],"variable":[{"key":"tagID","value":"4FfT87ZfNpOj5aP4E4N3"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"806a8544-8630-43b1-8687-a89f85ec7c3a"}],"id":"d99e96cd-5357-4fe1-9c3a-e98e07587805","_postman_id":"d99e96cd-5357-4fe1-9c3a-e98e07587805","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","name":"Workfeed API (prod)","type":"collection"}}},{"name":"Transactions","item":[{"name":"Create transactions","id":"76a40dd2-8809-4e13-a1d6-803183bc1f77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"date\": \"2023-07-14T13:37:00.000Z\",\n \"source\": \"Superb\",\n \"externalCompanyID\": \"externalCompanyID\",\n \"transactionType\": \"OTHER\",\n \"externalID\": \"externalID\",\n \"currency\": \"DKK\",\n \"netAmount\": 80,\n \"taxAmount\": 20,\n \"externalEmployeeID\": \"externalEmployeeID\",\n \"externalDepartmentID\": \"externalDepartmentID\",\n \"transactionLines\": [\n {\n \"quantity\": 1,\n \"externalProductID\": \"externalProductID1\",\n \"externalVariantID\": \"externalVariantID1\",\n \"productPrice\": 45,\n \"netAmount\": 36,\n \"taxAmount\": 9,\n \"productSpecificDiscountValue\": null\n },\n {\n \"quantity\": 1,\n \"externalProductID\": \"externalProductID2\",\n \"externalVariantID\": \"externalVariantID2\",\n \"productPrice\": 55,\n \"netAmount\": 44,\n \"taxAmount\": 11,\n \"productSpecificDiscountValue\": null\n }\n ],\n \"transactionDiscount\": null\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/transactions","description":"

Request Fields

Body	Description	Type / Format	Example
`date`	Transaction Date	an ISO 8601 encoded `string`	`2023-07-14T13:37:00.000Z`
source	Options: `Ajour` / `NemPOS` / `OnlinePOS` / `Zettle` / `Superb` / `Shopify` / `Square` / `Clover` / `Piranya` / `Sitoo / Fresto`	`string`	`Superb`
externalCompanyID	Your External Company ID	`string`	`83642`
transactionType	Options: `POS` / `WEB_SHOP` / `OTHER`	`string`	`OTHER`
externalID	Your External Transaction ID	`string`	`9217836611`
currency	Options: `EUR` / `JPY` / `GBP` / `DKK` etc...	an ISO 4217 encoded `string`	`DKK`
netAmount	Transaction Total Net Value	`number`	`80`
taxAmount	Total Tax applied to the Transaction	`number`	`20`
tipAmountReceived	Total amount of tips received for the Transaction	`number` / `null`	`25`
externalEmployeeID	Your External Employee ID	`string`	`1234`
externalDepartmentID	Your External Department ID	`string`	`4321`
transactionLines	Array of Products	`Array of Objects`	`[{...}...]`
object.quantity	Nr of Products	`number`	`1`
object.externalProductID	Your Product ID	`string`
object.externalVariantID	Your Product Variant ID	`string`
object.productPrice	Product price	`number` / `null`	`45`
object.netAmount	Transaction Net Amount	`number` / `null`	`36`
object.taxAmount	Tax applied to the Transaction	`number` / `null`	`9`
object.productSpecificDiscountValue	If Product has a Discount	`number` / `null`	`null`
transactionDiscount	Transaction Discount Object	`object` / `null`
transactionDiscount.percentage	Percentage Discounted applied to transaction	`number`	`10`
transactionDiscount.quantity	How many Discounts	`number`	`1`
transactionDiscount.value	Number Discounted applied to transaction	`number`	`15`

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
id	Array of created Transactions IDs	`string[]`	{ \"ids\": [\"\"...] }

","urlObject":{"path":["companies","COMPANY_ID","transactions"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[]}},"response":[{"id":"7b5bc0af-8475-4691-b303-11f4942692e1","name":"Create transactions","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"date\": \"2023-07-14T13:37:00.000Z\",\n \"source\": \"Superb\",\n \"externalCompanyID\": \"externalCompanyID\",\n \"transactionType\": \"OTHER\",\n \"externalID\": \"externalID\",\n \"currency\": \"DKK\",\n \"netAmount\": 80,\n \"taxAmount\": 20,\n \"externalEmployeeID\": \"externalEmployeeID\",\n \"externalDepartmentID\": \"externalDepartmentID\",\n \"transactionLines\": [\n {\n \"quantity\": 1,\n \"externalProductID\": \"externalProductID1\",\n \"externalVariantID\": \"externalVariantID1\",\n \"productPrice\": 45,\n \"netAmount\": 36,\n \"taxAmount\": 9,\n \"productSpecificDiscountValue\": null\n },\n {\n \"quantity\": 1,\n \"externalProductID\": \"externalProductID2\",\n \"externalVariantID\": \"externalVariantID2\",\n \"productPrice\": 55,\n \"netAmount\": 44,\n \"taxAmount\": 11,\n \"productSpecificDiscountValue\": null\n }\n ],\n \"transactionDiscount\": null\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/transactions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ids\": [\n \"6mRbTZW5tT2zAbqZyNNQ\"\n ]\n}"}],"_postman_id":"76a40dd2-8809-4e13-a1d6-803183bc1f77"},{"name":"Get transaction","id":"01aada66-602f-4f93-b6ec-271a2f01b98a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/transactions/:transactionID","description":"

Response Fields

Body	Description	Type / Format	Example
`id`	Transaction Id	`string`	`6mRbTZW5tT2zAbqZyNNQ`
currency	Options: `EUR` / `JPY` / `GBP` / `DKK` etc...	an ISO 4217 encoded `string`	`DKK`
`date`	Transaction Date	an ISO 8601 encoded `string`	`2023-07-14T13:37:00.000Z`
externalCompanyID	Your External Company ID	`string`
externalEmployeeID	Your External Employee ID	`string`	`1234`
externalDepartmentID	Your External Department ID	`string`	`4321`
externalID	Your External Transaction ID	`string`	`9217836611`
netAmount	Transaction Total Net Value	`number`	`80`
source	Options: `Ajour` / `NemPOS` / `OnlinePOS` / `Zettle` / `Superb` / `Shopify` / `Square` / `Clover` / `Piranya` / `Sitoo / Fresto`	`string`	`Superb`
taxAmount	Total Tax applied to the Transaction	`number`	`20`
tipAmountReceived	Total amount of tips received for the Transaction	`number` / `null`	`25`
transactionDiscount	Transaction Discount Object	`object` / `null`
transactionDiscount.percentage	Percentage Discounted applied to transaction	`number`	`10`
transactionDiscount.quantity	How many Discounts	`number`	`1`
transactionDiscount.value	Number Discounted applied to transaction	`number`	`15`
transactionLines	Array of Products	`Array of Objects`	`[{...}...]`
object.quantity	Nr of Products	`number`	`1`
object.externalProductID	Your Product ID	`string`
object.externalVariantID	Your Product Variant ID	`string`
object.productPrice	Product price	`number` / `null`	`45`
object.netAmount	Transaction Net Amount	`number` / `null`	`36`
object.taxAmount	Tax applied to the Transaction	`number` / `null`	`9`
object.productSpecificDiscountValue	If Product has a Discount	`number` / `null`	`null`
transactionType	Options: `POS` / `WEB_SHOP` / `OTHER`	`string`	`OTHER`
createTime	When Transaction was created	an ISO 8601 encoded `string`	`2023-10-28T16:19:41.998Z`
updateTime	When Transaction was updated	an ISO 8601 encoded `string`	`2023-10-28T16:19:41.998Z`

","urlObject":{"path":["companies","COMPANY_ID","transactions",":transactionID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"description":{"content":"

Transaction Id

\n","type":"text/plain"},"type":"any","value":"","key":"transactionID"}]}},"response":[{"id":"72623cbb-7e14-4e84-9a87-273f1eef7513","name":"Get transaction","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/transactions/:transactionID","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","transactions",":transactionID"],"variable":[{"key":"transactionID","value":"6mRbTZW5tT2zAbqZyNNQ"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6mRbTZW5tT2zAbqZyNNQ\",\n \"currency\": \"DKK\",\n \"date\": \"2023-07-14T13:37:00.000Z\",\n \"externalCompanyID\": \"externalCompanyID\",\n \"externalDepartmentID\": \"externalDepartmentID\",\n \"externalEmployeeID\": \"externalEmployeeID\",\n \"externalID\": \"externalID\",\n \"netAmount\": 80,\n \"source\": \"Superb\",\n \"taxAmount\": 20,\n \"transactionDiscount\": null,\n \"transactionLines\": [\n {\n \"quantity\": 1,\n \"netAmount\": 36,\n \"externalVariantID\": \"externalVariantID1\",\n \"productSpecificDiscountValue\": null,\n \"externalProductID\": \"externalProductID1\",\n \"taxAmount\": 9,\n \"productPrice\": 45\n },\n {\n \"quantity\": 1,\n \"netAmount\": 44,\n \"externalVariantID\": \"externalVariantID2\",\n \"productSpecificDiscountValue\": null,\n \"externalProductID\": \"externalProductID2\",\n \"taxAmount\": 11,\n \"productPrice\": 55\n }\n ],\n \"transactionType\": \"OTHER\",\n \"createTime\": \"2023-10-28T16:19:41.998Z\",\n \"updateTime\": \"2023-10-28T16:19:41.998Z\"\n}"}],"_postman_id":"01aada66-602f-4f93-b6ec-271a2f01b98a"},{"name":"Get transactions","id":"5e00b536-9a6a-418f-a565-6fe3597a49d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/transactions?from=2023-07-01T00:00:00.000Z&to=2023-08-02T00:00:00.000Z","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Required	Description	Type / format	Example
from	Yes	Only get Transactions starting on or after this time	an ISO 8601 encoded `string`	`2023-07-01T00:00:00.000Z`
to	Yes	Only get Transactions starting before this time	an ISO 8601 encoded `string`	`2023-10-30T00:00:00.000Z`

Response Fields

Body	Description	Type / Format	Example
`id`	Transaction Id	`string`	`6mRbTZW5tT2zAbqZyNNQ`
currency	Options: `EUR` / `JPY` / `GBP` / `DKK` etc...	an ISO 4217 encoded `string`	`DKK`
`date`	Transaction Date	an ISO 8601 encoded `string`	`2023-07-14T13:37:00.000Z`
externalCompanyID	Your External Company ID	`string`
externalEmployeeID	Your External Employee ID	`string`	`1234`
externalDepartmentID	Your External Department ID	`string`	`4321`
externalID	Your External Transaction ID	`string`	`9217836611`
netAmount	Transaction Total Net Value	`number`	`80`
source	Options: `Ajour` / `NemPOS` / `OnlinePOS` / `Zettle` / `Superb` / `Shopify` / `Square` / `Clover` / `Piranya` / `Sitoo / Fresto`	`string`	`Superb`
taxAmount	Total Tax applied to the Transaction	`number`	`20`
tipAmountReceived	Total amount of tips received for the Transaction	`number` / `null`	`25`
transactionDiscount	Transaction Discount Object	`object` / `null`
transactionDiscount.percentage	Percentage Discounted applied to transaction	`number`	`10`
transactionDiscount.quantity	How many Discounts	`number`	`1`
transactionDiscount.value	Number Discounted applied to transaction	`number`	`15`
transactionLines	Array of Products	`Array of Objects`	`[{...}...]`
object.quantity	Nr of Products	`number`	`1`
object.externalProductID	Your Product ID	`string`
object.externalVariantID	Your Product Variant ID	`string`
object.productPrice	Product price	`number` / `null`	`45`
object.netAmount	Transaction Net Amount	`number` / `null`	`36`
object.taxAmount	Tax applied to the Transaction	`number` / `null`	`9`
object.productSpecificDiscountValue	If Product has a Discount	`number` / `null`	`null`
transactionType	Options: `POS` / `WEB_SHOP` / `OTHER`	`string`	`OTHER`
createTime	When Transaction was created	an ISO 8601 encoded `string`	`2023-10-28T16:19:41.998Z`
updateTime	When Transaction was updated	an ISO 8601 encoded `string`	`2023-10-28T16:19:41.998Z`

","urlObject":{"path":["companies","COMPANY_ID","transactions"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[{"key":"from","value":"2023-07-01T00:00:00.000Z"},{"key":"to","value":"2023-08-02T00:00:00.000Z"}],"variable":[]}},"response":[{"id":"970a43df-dd62-487f-a377-0bc4d6f99dbe","name":"Get transactions","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/transactions?from=2023-07-01T00:00:00.000Z&to=2023-10-30T00:00:00.000Z","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","transactions"],"query":[{"key":"from","value":"2023-07-01T00:00:00.000Z"},{"key":"to","value":"2023-10-30T00:00:00.000Z"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"6mRbTZW5tT2zAbqZyNNQ\",\n \"currency\": \"DKK\",\n \"date\": \"2023-07-14T13:37:00.000Z\",\n \"externalCompanyID\": \"externalCompanyID\",\n \"externalDepartmentID\": \"externalDepartmentID\",\n \"externalEmployeeID\": \"externalEmployeeID\",\n \"externalID\": \"externalID\",\n \"netAmount\": 80,\n \"source\": \"Superb\",\n \"taxAmount\": 20,\n \"transactionDiscount\": null,\n \"transactionLines\": [\n {\n \"quantity\": 1,\n \"netAmount\": 36,\n \"externalVariantID\": \"externalVariantID1\",\n \"productSpecificDiscountValue\": null,\n \"externalProductID\": \"externalProductID1\",\n \"taxAmount\": 9,\n \"productPrice\": 45\n },\n {\n \"quantity\": 1,\n \"netAmount\": 44,\n \"externalVariantID\": \"externalVariantID2\",\n \"productSpecificDiscountValue\": null,\n \"externalProductID\": \"externalProductID2\",\n \"taxAmount\": 11,\n \"productPrice\": 55\n }\n ],\n \"transactionType\": \"OTHER\",\n \"createTime\": \"2023-10-28T16:19:41.998Z\",\n \"updateTime\": \"2023-10-28T16:19:41.998Z\"\n }\n]"}],"_postman_id":"5e00b536-9a6a-418f-a565-6fe3597a49d5"},{"name":"Delete transaction","id":"a2c80220-84f0-456b-9ecd-17b32f70372f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/transactions/:transactionID","urlObject":{"path":["companies","COMPANY_ID","transactions",":transactionID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"id":"216c3f55-4b8c-497d-a9a9-f5b43a8a3d26","description":{"content":"

Transaction Id

\n","type":"text/plain"},"type":"any","value":"","key":"transactionID"}]}},"response":[{"id":"35ee1998-fd77-43f7-bc66-59ce768959b8","name":"Delete transaction","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/transactions/:transactionID","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","transactions",":transactionID"],"variable":[{"key":"transactionID","value":"6mRbTZW5tT2zAbqZyNNQ"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"a2c80220-84f0-456b-9ecd-17b32f70372f"}],"id":"4c5fa6cb-6fb0-43d6-9bc2-7096efa7272b","_postman_id":"4c5fa6cb-6fb0-43d6-9bc2-7096efa7272b","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","name":"Workfeed API (prod)","type":"collection"}}},{"name":"Table Bookings","item":[{"name":"Create table booking","id":"30e1583f-644a-4323-aa34-4e208171b923","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"tableBookingIntegration\": \"EasyTableBooking\",\n \"externalBookingID\": \"12345678\",\n \"from\": \"2024-05-28T00:00:00Z\",\n \"durationInMinutes\": 60,\n \"status\": \"ACTIVE\",\n \"numberOfGuests\": 12,\n \"walkIn\": false,\n \"placeToken\": \"#1234FBTest\"\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/table-booking","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

TableBookingIntegration	Status
EasyTableBooking	`ACTIVE` / `CANCELLED` / `NOT_ARRIVED`
DinnerBooking	`current` / `waiting` / `deleted` / `no_show` / `payment_error` / `moved`
Formitable	`created` / `accepted` / `cancelled` / `failed` / `expired`
BookEtBord	`temporary` / `created` / `arrived` / `payed` / `completed` / `cancelled` / `deleted` / `noshow`

Request Fields

Body	Required	Description	Type / Format	Example
`tableBookingIntegration`	Yes	Options: `EasyTableBooking` / `DinnerBooking` / `Formitable` / `BookEtBord`	`string`	`EasyTableBooking`
externalBookingID	Yes	External booking ID from the integration system	`string`	`12345678`
from	Yes	Timestamp representing the start time of the booking	an ISO 8601 encoded `string`	`2024-05-28T00:00:00Z`
durationInMinutes	Yes	Duration of the booking in minutes	`number`	`60`
status	Yes	Table Booking Status. Note: See the Table above with the list of possible status, according to `tableBookingIntegration`	`string`	`ACTIVE`
numberOfGuests	Yes	Number of guests for the booking	`number`	`12`
walkIn	Yes	Indicates whether the booking is a walk-in	`boolean`	`false`
placeToken	Yes	Token representing the place of the booking	`string`	`#1234FBTest`
employeeNote	False	Note from the employee handling the booking	`string`	`Test Note`
arrived	False	Indicates whether the customer has arrived	`boolean`	`False`
timeOfBooking	False	Timestamp representing the time of the booking	an ISO 8601 encoded `string`	`2024-05-28T00:00:00Z`
customerID	False	ID of the customer	`string`	`1234`
customerName	False	Name of the customer	`string`	`Foo`
customerEmail	False	Email of the customer	`string`	`test@example.com`
customerNote	False	Note from the customer	`string`	`Test Note`

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
id	ID of created Table Booking	`string`	{ \"id\": \"\" }

","urlObject":{"path":["companies","COMPANY_ID","table-booking"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[]}},"response":[{"id":"89dd03af-7525-4a5f-9b28-0e34c3ee2cde","name":"Create table booking","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tableBookingIntegration\": \"EasyTableBooking\",\n \"externalBookingID\": \"12345678\",\n \"from\": \"2024-05-28T00:00:00Z\",\n \"durationInMinutes\": 60,\n \"status\": \"ACTIVE\",\n \"numberOfGuests\": 12,\n \"walkIn\": false,\n \"placeToken\": \"#1234FBTest\"\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/table-booking"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"4LZ5mgZsezQcwvVsA6UC\"\n}"}],"_postman_id":"30e1583f-644a-4323-aa34-4e208171b923"},{"name":"Update table booking","id":"05f5df04-26e4-4ffd-adf3-982568762b61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"tableBookingIntegration\": \"EasyTableBooking\",\n \"externalBookingID\": \"12345678\",\n \"from\": \"2024-05-28T00:00:00Z\",\n \"durationInMinutes\": 60,\n \"status\": \"ACTIVE\",\n \"numberOfGuests\": 12,\n \"walkIn\": false,\n \"placeToken\": \"#1234FBTest\"\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/table-booking/:tableBookingID","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

TableBookingIntegration	Status
EasyTableBooking	`ACTIVE` / `CANCELLED` / `NOT_ARRIVED`
DinnerBooking	`current` / `waiting` / `deleted` / `no_show` / `payment_error` / `moved`
Formitable	`created` / `accepted` / `cancelled` / `failed` / `expired`
BookEtBord	`temporary` / `created` / `arrived` / `payed` / `completed` / `cancelled` / `deleted` / `noshow`

Request Fields

Body	Required	Description	Type / Format	Example
tableBookingIntegration	False	Options: `EasyTableBooking` / `DinnerBooking` / `Formitable` / `BookEtBord`	`string`	`EasyTableBooking`
externalBookingID	False	External booking ID from the integration system	`string`	`12345678`
from	False	Timestamp representing the start time of the booking. NOTE: if `from` is present in the body, `durationInMinutes` must also be present	an ISO 8601 encoded `string`	`2024-05-28T00:00:00Z`
durationInMinutes	False	Duration of the booking in minutes NOTE: if `durationInMinutes` is present in the body, `from` must also be present	`number`	`60`
status	False	Table Booking Status. Note: See the Table above with the list of possible status, according to `tableBookingIntegration`	`string`	`ACTIVE`
numberOfGuests	False	Number of guests for the booking	`number`	`12`
walkIn	False	Indicates whether the booking is a walk-in	`boolean`	`false`
placeToken	False	Token representing the place of the booking	`string`	`#1234FBTest`
employeeNote	False	Note from the employee handling the booking	`string`	`Test Note`
arrived	False	Indicates whether the customer has arrived	`boolean`	`False`
timeOfBooking	False	Timestamp representing the time of the booking	an ISO 8601 encoded `string`	`2024-05-28T00:00:00Z`
customerID	False	ID of the customer	`string`	`1234`
customerName	False	Name of the customer	`string`	`Foo`
customerEmail	False	Email of the customer	`string`	`test@example.com`
customerNote	False	Note from the customer	`string`	`Test Note`

Response Fields

Body	Description	Type / Format	Example
id	Table Booking ID	`string`	`4LZ5mgZsezQcwvVsA6UC`
start	When Table Booking starts	`string`	`2024-05-28T00:00:00Z`
end	When Table Booking ends. Can be `null` for certain booking sources that don't support end times.	`string` / `null`	`2024-05-28T01:00:00Z`
tableBookingIntegration		`string`	`EasyTableBooking`
externalBookingID	External booking ID from the integration system	`string`	`12345678`
durationInMinutes	Duration of the booking in minutes. Can be `null` for certain booking sources that don't support end times.	`number` / `null`	`60`
status	Table Booking Status. Note: See the Table above with the list of possible status, according to `tableBookingIntegration`	`string`	`ACTIVE`
numberOfGuests	Number of guests for the booking	`number`	`12`
walkIn	Indicates whether the booking is a walk-in	`boolean`	`false`
placeToken	Token representing the place of the booking	`string`	`#1234FBTest`
employeeNote	Note from the employee handling the booking	`string`	`Test Note`
arrived	Indicates whether the customer has arrived	`boolean`	`False`
timeOfBooking	Timestamp representing the time of the booking	an ISO 8601 encoded `string`	`2024-05-28T00:00:00Z`
customerID	ID of the customer	`string`	`1234`
customerName	Name of the customer	`string`	`Foo`
customerEmail	Email of the customer	`string`	`test@example.com`
customerNote	Note from the customer	`string`	`Test Note`
createTime	When Table Booking was created	an ISO 8601 encoded `string`	`2023-10-28T16:19:41.998Z`
updateTime	When Table Booking was updated	an ISO 8601 encoded `string`	`2023-10-28T16:19:41.998Z`

","urlObject":{"path":["companies","COMPANY_ID","table-booking",":tableBookingID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"type":"any","value":"","key":"tableBookingID"}]}},"response":[{"id":"78f57426-b669-4ab0-9f96-e011b2d53765","name":"Update table booking","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tableBookingIntegration\": \"EasyTableBooking\",\n \"externalBookingID\": \"12345678\",\n \"from\": \"2024-05-28T00:00:00Z\",\n \"durationInMinutes\": 60,\n \"status\": \"ACTIVE\",\n \"numberOfGuests\": 12,\n \"walkIn\": false,\n \"placeToken\": \"#1234FBTest\"\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/table-booking"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"4LZ5mgZsezQcwvVsA6UC\",\n \"start\": \"2024-05-28T00:00:00.000Z\",\n \"end\": \"2024-05-28T01:00:00.000Z\",\n \"tableBookingIntegration\": \"EasyTableBooking\",\n \"externalBookingID\": \"12345678\",\n \"durationInMinutes\": 60,\n \"arrived\": null,\n \"status\": \"ACTIVE\",\n \"numberOfGuests\": 12,\n \"walkIn\": false,\n \"customerID\": null,\n \"customerName\": null,\n \"customerEmail\": null,\n \"placeToken\": \"#1234FBTest\",\n \"customerNote\": null,\n \"employeeNote\": null,\n \"timeOfBooking\": null,\n \"createTime\": \"2024-06-10T15:09:11.484Z\",\n \"updateTime\": \"2024-06-10T15:09:11.484Z\"\n}"}],"_postman_id":"05f5df04-26e4-4ffd-adf3-982568762b61"},{"name":"Get table booking","id":"b423d676-c5fa-4c50-99ec-f0975c9bbf4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/table-booking/:tableBookingID","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

TableBookingIntegration	Status
EasyTableBooking	`ACTIVE` / `CANCELLED` / `NOT_ARRIVED`
DinnerBooking	`current` / `waiting` / `deleted` / `no_show` / `payment_error` / `moved`
Formitable	`created` / `accepted` / `cancelled` / `failed` / `expired`
BookEtBord	`temporary` / `created` / `arrived` / `payed` / `completed` / `cancelled` / `deleted` / `noshow`

Response Fields

Body	Description	Type / Format	Example
id	Table Booking ID	`string`	`4LZ5mgZsezQcwvVsA6UC`
start	When Table Booking starts	`string`	`2024-05-28T00:00:00Z`
end	When Table Booking ends. Can be `null` for certain booking sources that don't support end times.	`string` / `null`	`2024-05-28T01:00:00Z`
tableBookingIntegration	Options: `EasyTableBooking` / `DinnerBooking` / `Formitable` / `BookEtBord`	`string`	`EasyTableBooking`
externalBookingID	External booking ID from the integration system	`string`	`12345678`
durationInMinutes	Duration of the booking in minutes. Can be `null` for certain booking sources that don't support end times.	`number` / `null`	`60`
status	Table Booking Status. Note: See the Table above with the list of possible status, according to `tableBookingIntegration`	`string`	`ACTIVE`
numberOfGuests	Number of guests for the booking	`number`	`12`
walkIn	Indicates whether the booking is a walk-in	`boolean`	`false`
placeToken	Token representing the place of the booking	`string`	`#1234FBTest`
employeeNote	Note from the employee handling the booking	`string`	`Test Note`
arrived	Indicates whether the customer has arrived	`boolean`	`False`
timeOfBooking	Timestamp representing the time of the booking	an ISO 8601 encoded `string`	`2024-05-28T00:00:00Z`
customerID	ID of the customer	`string`	`1234`
customerName	Name of the customer	`string`	`Foo`
customerEmail	Email of the customer	`string`	`test@example.com`
customerNote	Note from the customer	`string`	`Test Note`
createTime	When Table Booking was created	an ISO 8601 encoded `string`	`2023-10-28T16:19:41.998Z`
updateTime	When Table Booking was updated	an ISO 8601 encoded `string`	`2023-10-28T16:19:41.998Z`

","urlObject":{"path":["companies","COMPANY_ID","table-booking",":tableBookingID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"type":"any","value":"","key":"tableBookingID"}]}},"response":[{"id":"b47a21d3-6eba-40d2-baf1-13256ed19d5b","name":"Get table booking","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/table-booking/:tableBookingID","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","table-booking",":tableBookingID"],"variable":[{"key":"tableBookingID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"4LZ5mgZsezQcwvVsA6UC\",\n \"start\": \"2024-05-28T00:00:00.000Z\",\n \"end\": \"2024-05-28T01:00:00.000Z\",\n \"tableBookingIntegration\": \"EasyTableBooking\",\n \"externalBookingID\": \"12345678\",\n \"durationInMinutes\": 60,\n \"arrived\": null,\n \"status\": \"ACTIVE\",\n \"numberOfGuests\": 12,\n \"walkIn\": false,\n \"customerID\": null,\n \"customerName\": null,\n \"customerEmail\": null,\n \"placeToken\": \"#1234FBTest\",\n \"customerNote\": null,\n \"employeeNote\": null,\n \"timeOfBooking\": null,\n \"createTime\": \"2024-06-10T15:09:11.484Z\",\n \"updateTime\": \"2024-06-10T15:09:11.484Z\"\n}"}],"_postman_id":"b423d676-c5fa-4c50-99ec-f0975c9bbf4e"},{"name":"Get table bookings","id":"64d2b395-6d69-4a3e-ab24-ee56f1206d46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/table-booking?from=2024-05-26T00:00:00.000Z&to=2024-05-30T00:00:00.000Z","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

TableBookingIntegration	Status
EasyTableBooking	`ACTIVE` / `CANCELLED` / `NOT_ARRIVED`
DinnerBooking	`current` / `waiting` / `deleted` / `no_show` / `payment_error` / `moved`
Formitable	`created` / `accepted` / `cancelled` / `failed` / `expired`
BookEtBord	`temporary` / `created` / `arrived` / `payed` / `completed` / `cancelled` / `deleted` / `noshow`

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Required	Description	Type / format	Example
from	Yes	Only get Table Bookings starting on or after this time	an ISO 8601 encoded `string`	`2023-07-01T00:00:00.000Z`
to	Yes	Only get Table Bookings starting before this time	an ISO 8601 encoded `string`	`2023-10-30T00:00:00.000Z`

Response Fields

Body	Description	Type / Format	Example
id	Table Booking ID	`string`	`4LZ5mgZsezQcwvVsA6UC`
start	When Table Booking starts	`string`	`2024-05-28T00:00:00Z`
end	When Table Booking ends. Can be `null` for certain booking sources that don't support end times.	`string` / `null`	`2024-05-28T01:00:00Z`
tableBookingIntegration	Options: `EasyTableBooking` / `DinnerBooking` / `Formitable` / `BookEtBord`	`string`	`EasyTableBooking`
externalBookingID	External booking ID from the integration system	`string`	`12345678`
durationInMinutes	Duration of the booking in minutes. Can be `null` for certain booking sources that don't support end times.	`number` / `null`	`60`
status	Table Booking Status. Note: See the Table above with the list of possible status, according to `tableBookingIntegration`	`string`	`ACTIVE`
numberOfGuests	Number of guests for the booking	`number`	`12`
walkIn	Indicates whether the booking is a walk-in	`boolean`	`false`
placeToken	Token representing the place of the booking	`string`	`#1234FBTest`
employeeNote	Note from the employee handling the booking	`string`	`Test Note`
arrived	Indicates whether the customer has arrived	`boolean`	`False`
timeOfBooking	Timestamp representing the time of the booking	an ISO 8601 encoded `string`	`2024-05-28T00:00:00Z`
customerID	ID of the customer	`string`	`1234`
customerName	Name of the customer	`string`	`Foo`
customerEmail	Email of the customer	`string`	`test@example.com`
customerNote	Note from the customer	`string`	`Test Note`
createTime	When Table Booking was created	an ISO 8601 encoded `string`	`2023-10-28T16:19:41.998Z`
updateTime	When Table Booking was updated	an ISO 8601 encoded `string`	`2023-10-28T16:19:41.998Z`

","urlObject":{"path":["companies","COMPANY_ID","table-booking"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[{"key":"from","value":"2024-05-26T00:00:00.000Z"},{"key":"to","value":"2024-05-30T00:00:00.000Z"}],"variable":[]}},"response":[{"id":"8981d442-ac48-48b5-badd-777a46f50fb5","name":"Get table bookings","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/table-booking?from=2024-05-26T00:00:00.000Z&to=2024-05-30T00:00:00.000Z","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","table-booking"],"query":[{"key":"from","value":"2024-05-26T00:00:00.000Z"},{"key":"to","value":"2024-05-30T00:00:00.000Z"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"4LZ5mgZsezQcwvVsA6UC\",\n \"start\": \"2024-05-28T00:00:00.000Z\",\n \"end\": \"2024-05-28T01:00:00.000Z\",\n \"tableBookingIntegration\": \"EasyTableBooking\",\n \"externalBookingID\": \"12345678\",\n \"durationInMinutes\": 60,\n \"arrived\": null,\n \"status\": \"ACTIVE\",\n \"numberOfGuests\": 12,\n \"walkIn\": false,\n \"customerID\": null,\n \"customerName\": null,\n \"customerEmail\": null,\n \"placeToken\": \"#1234FBTest\",\n \"customerNote\": null,\n \"employeeNote\": null,\n \"timeOfBooking\": null,\n \"createTime\": \"2024-06-10T15:09:11.484Z\",\n \"updateTime\": \"2024-06-10T15:09:11.484Z\"\n }\n]"}],"_postman_id":"64d2b395-6d69-4a3e-ab24-ee56f1206d46"},{"name":"Delete table booking","id":"7648c24f-8f0a-4d14-9ebd-1e52f7c6b832","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/table-booking/:tableBookingID","urlObject":{"path":["companies","COMPANY_ID","table-booking",":tableBookingID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"type":"any","value":"","key":"tableBookingID"}]}},"response":[{"id":"fc04c07a-a987-42fe-9764-9f43032a8600","name":"Delete table booking","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/table-booking/:tableBookingID","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","table-booking",":tableBookingID"],"variable":[{"key":"tableBookingID","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7648c24f-8f0a-4d14-9ebd-1e52f7c6b832"}],"id":"925486f0-b3a5-4766-862f-3ab083c3e0a6","_postman_id":"925486f0-b3a5-4766-862f-3ab083c3e0a6","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","name":"Workfeed API (prod)","type":"collection"}}},{"name":"Employees","item":[{"name":"Create employee","id":"f7f72bc2-c3ce-4aec-90bd-77f1d488c458","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"firstname\": \"API\",\n \"lastname\": \"Test\",\n \"email\": \"test2@example.com\",\n \"phone\": \"12345678\",\n \"roles\": [\n \"roleID\"\n ],\n \"departments\": [\n \"departmentID\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/employees","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Required	Description	Type / format	Example
`firstname`	Yes	The first name of the employee	`string`	`Foo`
`lastname`	Yes	The last name of the employee	`string`	`Bar`
`email`	Yes	The email of the employee. This is also the email at which they'll receive their invite to Workfeed	`string`	`test@example.com`
`phone`	Yes	The phone number of the employee	`string`	`12345678`
`roles`	Yes	The roles to assign the new employee	`string[]`	`[\"roleID1\", \"roleID2\"]`
`departments`	Yes	The departments to assign the new employee	`string[]`	`[\"departmentID1\"]`
`deletedOn`	No	The date and time when the employee was or will be soft-deleted	an ISO 8601 encoded `string`	`2026-01-20T12:42:02.000Z`

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / format	Example
id	New Employee ID	`string`	`J9QAIiTG0nRC1OsC5YvHfLWdDHn1`

","urlObject":{"path":["companies","COMPANY_ID","employees"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[]}},"response":[{"id":"1eee2039-1e13-49cd-94c5-8fbe6b9894ce","name":"Create employee","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstname\": \"API\",\n \"lastname\": \"Test\",\n \"email\": \"test2@example.com\",\n \"phone\": \"12345678\",\n \"roles\": [\n \"hLbEKIPTlMh3ehotXl0w\"\n ],\n \"departments\": [\n \"PKHaOSgFA4uguOqmLfWv\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/employees"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"J9QAIiTG0nRC1OsC5YvHfLWdDHn1\"\n}"}],"_postman_id":"f7f72bc2-c3ce-4aec-90bd-77f1d488c458"},{"name":"Update employee","id":"8c7fc854-efbe-417f-8b0c-81a86aff0f6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"firstname\": \"API\",\n \"lastname\": \"Test\",\n \"phone\": \"12345678\",\n \"roles\": [\n \"roleID1\",\n \"roleID2\",\n \"roleID3\"\n ],\n \"departments\": [\n \"departmentID\"\n ],\n \"email\": \"test@example.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/employees/:employeeID","description":"

Note: If you don't want to update a specific a field do not send it in the body

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Required	Description	Type / format	Example
`firstname`	No	The first name of the employee	`string`	`Foo`
`lastname`	No	The last name of the employee	`string`	`Bar`
`email`	No	The email of the employee. This is also the email at which they'll receive their invite to Workfeed	`string`	`test@example.com`
`phone`	No	The phone number of the employee	`string`	`12345678`
`roles`	No	The roles to assign the new employee	`string[]`	`[\"roleID1\", \"roleID2\"]`
`departments`	No	The departments to assign the new employee	`string[]`	`[\"departmentID1\"]`
`deletedOn`	No	The date and time when the employee was or will be soft-deleted. It is not possible to un-delete an employee after they've been deleted. That can only be done via the UI.	an ISO 8601 encoded `string`	`2026-01-20T12:42:02.000Z`

Response Fields

Body	Description	Type / format	Example
id	Employee ID	`string`	`J9QAIiTG0nRC1OsC5YvHfLWdDHn1`
firstname	The first name of the employee	`string`	`API 2`
lastname	The last name of the employee	`string`	`Test 2`
email	The email of the employee. This is also the email at which they'll receive their invite to Workfeed	`string`	`test2@example.com`
phone	The phone number of the employee	`string`	`12345678`
birthdate	The birthdate of the employee	An ISO 8601 encoded `string` (only the date part) `null` if no birthdate.	`2025-09-25`
`roleIDs`	The roles to assign the new employee	`string[]`	`[\"hLbEKIPTlMh3ehotXl0w\"]`
`departmentIDs`	The departments to assign the new employee	`string[]`	`[\"PKHaOSgFA4uguOqmLfWv\"]`
primaryDepartmentID	Employee Primary Department. Which means it will auto assign the Employee to the Department Shifts	`string` / `null`	`null`
street	The Street of the employee	`string`	`\"\"`
city	The City of the employee	`string`	`\"\"`
zip	The Zip Code of the employee	`string`	`\"\"`
accessLevel	Options: `employee` / `admin` / `manager`	`string`	`employee`
wage	Employee Wage Object	`object` / `null`	`null`
wage.amount	Amount by Hour when `wage.type` is set to hourly. Otherwise it represents Amount by Month	`number`	`20`
wage.type	Options: `\"hourly\"` / `\"monthly\"`	`string`	`monthly`
minHours	Employee Minimum Weekly Working Hours	`number` / `null`	`null`
maxHours	Employee Maximum Weekly Working Hours	`number` / `null`	`null`
isDeleted	If Employee was deleted	`boolean`	`false`
deletedOn	When the employee was or will be soft-deleted	an ISO 8601 encoded `string` / `null`	`2026-01-20T12:42:02.000Z`
ssn	SSN (Social Security Number), associdated with Employee	`string` / `null`	`null`
imageURL	Employee Image URL	`string` / `null`	`null`
createTime	When Employee was created	an ISO 8601 encoded `string`	`2023-10-28T18:22:45.695Z`
updateTime	When Employee was updated	an ISO 8601 encoded `string`	`2023-10-28T18:34:37.191Z`

","urlObject":{"path":["companies","COMPANY_ID","employees",":employeeID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"id":"fe098312-1e82-4b29-9857-6bb5a573a17d","description":{"content":"

Employee ID

\n","type":"text/plain"},"type":"string","value":"","key":"employeeID"}]}},"response":[{"id":"a6844cc7-60a7-4427-b3d0-b7b96cd8593c","name":"Update employee","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstname\": \"API 2\",\n \"lastname\": \"Test 2\"\n \n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/employees/:employeeID","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","employees",":employeeID"],"variable":[{"key":"employeeID","value":"J9QAIiTG0nRC1OsC5YvHfLWdDHn1","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"J9QAIiTG0nRC1OsC5YvHfLWdDHn1\",\n \"firstname\": \"API 2\",\n \"lastname\": \"Test 2\",\n \"email\": \"test2@example.com\",\n \"phone\": \"12345678\",\n \"roleIDs\": [\n \"hLbEKIPTlMh3ehotXl0w\"\n ],\n \"departmentIDs\": [\n \"PKHaOSgFA4uguOqmLfWv\"\n ],\n \"primaryDepartmentID\": null,\n \"street\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"accessLevel\": \"employee\",\n \"wage\": null,\n \"minHours\": null,\n \"maxHours\": null,\n \"isDeleted\": false,\n \"cpr\": \"\",\n \"createTime\": \"2023-10-28T18:22:45.695Z\",\n \"updateTime\": \"2023-10-28T18:34:37.191Z\"\n}"}],"_postman_id":"8c7fc854-efbe-417f-8b0c-81a86aff0f6a"},{"name":"Get employee","event":[{"listen":"test","script":{"id":"c75cc279-4425-409a-baed-4c9af80b4411","exec":["var template = `"," "," "," "," "," "," "," "," "," ",""," {{#each response}}"," {{#unless isDeleted}}"," "," "," "," "," "," "," "," {{/unless}}"," {{/each}}","

Name	Id	Deleted	Roles
{{firstname}} {{lastname}}	{{id}}	{{isDeleted}}	"," {{#each roleIDs}}"," {{this}} "," {{/each}}"," ","

","`;","","// Set visualizer","pm.visualizer.set(template, {"," // Pass the response body parsed as JSON as `data`"," response: pm.response.json()","});"],"type":"text/javascript"}}],"id":"6cb310d0-1593-4ae0-afaa-b893acb68c50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/employees/:employeeID","description":"

Response Fields

	Description	Type / format	Example
id	Employee ID	`string`	`J9QAIiTG0nRC1OsC5YvHfLWdDHn1`
firstname	The first name of the employee	`string`	`API 2`
lastname	The last name of the employee	`string`	`Test 2`
email	The email of the employee. This is also the email at which they'll receive their invite to Workfeed	`string`	`test2@example.com`
phone	The phone number of the employee	`string`	`12345678`
birthdate	The birthdate of the employee	An ISO 8601 encoded `string` (only the date part) `null` if no birthdate.	`2025-09-25`
`roleIDs`	The roles to assign the new employee	`string[]`	`[\"hLbEKIPTlMh3ehotXl0w\"]`
`departmentIDs`	The departments to assign the new employee	`string[]`	`[\"PKHaOSgFA4uguOqmLfWv\"]`
primaryDepartmentID	Employee Primary Department. Which means it will auto assign the Employee to the Department Shifts	`string` / `null`	`null`
street	The Street of the employee	`string`	`\"\"`
city	The City of the employee	`string`	`\"\"`
zip	The Zip Code of the employee	`string`	`\"\"`
accessLevel	Options: `employee` / `admin` / `manager`	`string`	`employee`
wage	Employee Wage Object	`object` / `null`	`null`
wage.amount	Amount by Hour when `wage.type` is set to hourly. Otherwise it represents Amount by Month	`number`	`20`
wage.type	Options: `\"hourly\"` / `\"monthly\"`	`string`	`monthly`
minHours	Employee Minimum Weekly Working Hours	`number` / `null`	`null`
maxHours	Employee Maximum Weekly Working Hours	`number` / `null`	`null`
isDeleted	If Employee was deleted	`boolean`	`false`
deletedOn	When the employee was or will be soft-deleted. `null` if no deletion has happened or is pending.	an ISO 8601 encoded `string` / `null`	`2026-01-20T12:42:02.000Z`
ssn	SSN (Social Security Number), associdated with Employee	`string` / `null`	`null`
imageURL	Employee Image URL	`string` / `null`	`null`
createTime	When Employee was created	an ISO 8601 encoded `string`	`2023-10-28T18:22:45.695Z`
updateTime	When Employee was updated	an ISO 8601 encoded `string`	`2023-10-28T18:34:37.191`

","urlObject":{"path":["companies","COMPANY_ID","employees",":employeeID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"id":"2a6a4a26-84c6-4cfe-997f-404819a1c04a","description":{"content":"

Employee ID

\n","type":"text/plain"},"type":"any","value":"","key":"employeeID"}]}},"response":[{"id":"8046be07-6a69-47b8-a50b-7fe6e5bc27ab","name":"Get employee","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/employees/:employeeID","protocol":"https","host":["europe-west1-production-eu-327a3","cloudfunctions","net"],"path":["api","companies","COMPANY_ID","employees",":employeeID"],"variable":[{"key":"employeeID","value":"J9QAIiTG0nRC1OsC5YvHfLWdDHn1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"J9QAIiTG0nRC1OsC5YvHfLWdDHn1\",\n \"firstname\": \"API 2\",\n \"lastname\": \"Test 2\",\n \"email\": \"test2@example.com\",\n \"phone\": \"12345678\",\n \"roleIDs\": [\n \"hLbEKIPTlMh3ehotXl0w\"\n ],\n \"departmentIDs\": [\n \"PKHaOSgFA4uguOqmLfWv\"\n ],\n \"primaryDepartmentID\": null,\n \"street\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"accessLevel\": \"employee\",\n \"wage\": null,\n \"minHours\": null,\n \"maxHours\": null,\n \"isDeleted\": false,\n \"ssn\": \"\",\n \"imageURL\": null,\n \"createTime\": \"2023-10-28T18:22:45.695Z\",\n \"updateTime\": \"2023-10-28T18:34:37.191Z\"\n}"}],"_postman_id":"6cb310d0-1593-4ae0-afaa-b893acb68c50"},{"name":"Get employees","event":[{"listen":"test","script":{"id":"feec7235-17fa-425c-a90d-cc052ce0237a","exec":["var template = `"," "," "," "," "," "," "," "," "," ",""," {{#each response}}"," {{#unless isDeleted}}"," "," "," "," "," "," "," "," {{/unless}}"," {{/each}}","

Name	Id	Deleted	Roles
{{firstname}} {{lastname}}	{{id}}	{{isDeleted}}	"," {{#each roleIDs}}"," {{this}} "," {{/each}}"," ","

","`;","","// Set visualizer","pm.visualizer.set(template, {"," // Pass the response body parsed as JSON as `data`"," response: pm.response.json()","});"],"type":"text/javascript","packages":{}}}],"id":"c64c11ad-608d-45da-b258-d8ac05a68679","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/employees","description":"

Response Fields

	Description	Type / format	Example
id	Employee ID	`string`	`J9QAIiTG0nRC1OsC5YvHfLWdDHn1`
firstname	The first name of the employee	`string`	`API 2`
lastname	The last name of the employee	`string`	`Test 2`
email	The email of the employee. This is also the email at which they'll receive their invite to Workfeed	`string`	`test2@example.com`
phone	The phone number of the employee	`string`	`12345678`
birthdate	The birthdate of the employee	An ISO 8601 encoded `string` (only the date part) `null` if no birthdate.	`2025-09-25`
`roleIDs`	The roles to assign the new employee	`string[]`	`[\"hLbEKIPTlMh3ehotXl0w\"]`
`departmentIDs`	The departments to assign the new employee	`string[]`	`[\"PKHaOSgFA4uguOqmLfWv\"]`
primaryDepartmentID	Employee Primary Department. Which means it will auto assign the Employee to the Department Shifts	`string` / `null`	`null`
street	The Street of the employee	`string`	`\"\"`
city	The City of the employee	`string`	`\"\"`
zip	The Zip Code of the employee	`string`	`\"\"`
accessLevel	Options: `employee` / `admin` / `manager`	`string`	`employee`
wage	Employee Wage Object	`object` / `null`	`null`
wage.amount	Amount by Hour when `wage.type` is set to hourly. Otherwise it represents Amount by Month	`number`	`20`
wage.type	Options: `\"hourly\"` / `\"monthly\"`	`string`	`monthly`
minHours	Employee Minimum Weekly Working Hours	`number` / `null`	`null`
maxHours	Employee Maximum Weekly Working Hours	`number` / `null`	`null`
isDeleted	If Employee was deleted	`boolean`	`false`
deletedOn	When the employee was or will be soft-deleted. `null` if no deletion has happened or is pending.	an ISO 8601 encoded `string` / `null`	`2026-01-20T12:42:02.000Z`
ssn	SSN (Social Security Number), associdated with Employee	`string` / `null`	`null`
imageURL	Employee Image URL	`string` / `null`	`null`
createTime	When Employee was created	an ISO 8601 encoded `string`	`2023-10-28T18:22:45.695Z`
updateTime	When Employee was updated	an ISO 8601 encoded `string`	`2023-10-28T18:34:37.191`

","urlObject":{"path":["companies","COMPANY_ID","employees"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[]}},"response":[{"id":"d9a17fd0-4e10-4918-a8c6-d75ff70bebc9","name":"Get employees","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/employees"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"J9QAIiTG0nRC1OsC5YvHfLWdDHn1\",\n \"firstname\": \"API 2\",\n \"lastname\": \"Test 2\",\n \"email\": \"test2@example.com\",\n \"phone\": \"12345678\",\n \"roleIDs\": [\n \"hLbEKIPTlMh3ehotXl0w\"\n ],\n \"departmentIDs\": [\n \"PKHaOSgFA4uguOqmLfWv\"\n ],\n \"primaryDepartmentID\": null,\n \"street\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"accessLevel\": \"employee\",\n \"wage\": null,\n \"minHours\": null,\n \"maxHours\": null,\n \"isDeleted\": false,\n \"ssn\": \"\",\n \"imageURL\": null,\n \"createTime\": \"2023-10-28T18:22:45.695Z\",\n \"updateTime\": \"2023-10-28T18:34:37.191Z\"\n }\n]"}],"_postman_id":"c64c11ad-608d-45da-b258-d8ac05a68679"}],"id":"7fd3d275-7a9a-4bf6-8340-7b9651e8019c","_postman_id":"7fd3d275-7a9a-4bf6-8340-7b9651e8019c","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","name":"Workfeed API (prod)","type":"collection"}}},{"name":"Departments","item":[{"name":"Get departments","id":"653e4576-d5d7-4d06-a5a5-397453b0b00b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/departments","description":"

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
id	Department ID	`string`	`PKHaOSgFA4uguOqmLfWv`
name	Department Name	`string`	`API Testing Account😎`
isDeleted	Check if the Department was deleted	`boolean`	`false`
createTime	When the Department was created	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`
updateTime	When the Department was updated	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`

","urlObject":{"path":["companies","COMPANY_ID","departments"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[]}},"response":[{"id":"5c36470c-b91b-4111-8f83-cdc48ea0e1c6","name":"Get departments","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/departments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"PKHaOSgFA4uguOqmLfWv\",\n \"name\": \"API Testing Account 😎\",\n \"isDeleted\": false,\n \"createTime\": \"2023-10-25T09:43:06.650Z\",\n \"updateTime\": \"2023-10-25T09:43:06.650Z\"\n }\n]"}],"_postman_id":"653e4576-d5d7-4d06-a5a5-397453b0b00b"},{"name":"Get departments daily","id":"b7e35f94-6d10-4840-9e8e-cf5518e54dee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/departments/:departmentID/daily?from=2023-12-20&to=2024-12-21","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Required	Description	Type / format	Example
from	Yes	Only get Daily Notes starting on or after this time	an ISO 8601 encoded `string`	`2023-07-01T00:00:00.000Z`
to	Yes	Only get Daily Notes starting before this time	an ISO 8601 encoded `string`	`2023-10-30T00:00:00.000Z`

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
id	Daily Note ID, represents the day of the Note	`string`	`2023-12-21`
note	Daily Note	`object`
note.message	Note message	`string`	`Test`
note.senderID	Employee that created the Note	`string`	`sEx78CyrI2M9RDfsN99BL78BUKx2`
note.time	Daily Note Time	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`
manualRevenue	Manual Revenue inserted	`number` / `null`	`null`
createTime	When the Daily Note was created	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`
updateTime	When the Daily Note was updated	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`

","urlObject":{"path":["companies","COMPANY_ID","departments",":departmentID","daily"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[{"key":"from","value":"2023-12-20"},{"key":"to","value":"2024-12-21"}],"variable":[{"description":{"content":"

Department Id

\n","type":"text/plain"},"type":"any","value":"","key":"departmentID"}]}},"response":[{"id":"7fdfd4f1-0346-4986-8134-7dce305b04c4","name":"Get departments daily","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/departments/:departmentID/daily?from=2023-07-01T00:00:00.000Z&to=2023-08-02T00:00:00.000Z","protocol":"https","host":["europe-west1-production-eu-327a3","cloudfunctions","net"],"path":["api","companies","COMPANY_ID","departments",":departmentID","daily"],"query":[{"key":"from","value":"2023-07-01T00:00:00.000Z"},{"key":"to","value":"2023-08-02T00:00:00.000Z"}],"variable":[{"key":"departmentID","value":"","description":"Department Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[ \n {\n \"id\": \"2023-12-21\",\n \"note\": {\n \"senderID\": \"sEx78CyrI2M9RDfsN99BL78BUKx2\",\n \"message\": \"Test\",\n \"time\": \"2023-12-12T16:42:12.375Z\"\n },\n \"manualRevenue\": null,\n \"createTime\": \"2023-12-12T00:45:18.115Z\",\n \"updateTime\": \"2023-12-12T16:42:12.573Z\"\n }\n]"}],"_postman_id":"b7e35f94-6d10-4840-9e8e-cf5518e54dee"},{"name":"Get daily note","id":"0ce5f204-4bc9-4edc-98e6-f0d8ae1dad78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/departments/:departmentID/daily/:dailyID","description":"

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
id	Daily Note ID, represents the day of the Note	`string`	`2023-12-21`
note	Daily Note	`object`
note.message	Note message	`string`	`Test`
note.senderID	Employee that created the Note	`string`	`sEx78CyrI2M9RDfsN99BL78BUKx2`
note.time	Daily Note Time	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`
manualRevenue	Manual Revenue inserted	`number` / `null`	`null`
createTime	When the Daily Note was created	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`
updateTime	When the Daily Note was updated	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`

","urlObject":{"path":["companies","COMPANY_ID","departments",":departmentID","daily",":dailyID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"id":"6ce23f09-d9b7-4679-9fa9-147358a2ce6c","description":{"content":"

Department Id

\n","type":"text/plain"},"type":"any","value":"","key":"departmentID"},{"id":"7f9d7c55-fbd0-423e-8c6c-cbf230940ef7","description":{"content":"

Daily Id

\n","type":"text/plain"},"type":"any","value":"","key":"dailyID"}]}},"response":[{"id":"dc9541da-a635-42d7-af85-1a28a63aaa83","name":"Get daily note","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/departments/:departmentID/daily/:dailyID","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","departments",":departmentID","daily",":dailyID"],"variable":[{"key":"departmentID","value":"","description":"Department Id"},{"key":"dailyID","value":"","description":"Daily Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2023-12-21\",\n \"note\": {\n \"senderID\": \"sEx78CyrI2M9RDfsN99BL78BUKx2\",\n \"message\": \"Test\",\n \"time\": \"2023-12-12T16:42:12.375Z\"\n },\n \"manualRevenue\": null,\n \"createTime\": \"2023-12-12T00:45:18.115Z\",\n \"updateTime\": \"2023-12-12T16:42:12.573Z\"\n}\n"}],"_postman_id":"0ce5f204-4bc9-4edc-98e6-f0d8ae1dad78"},{"name":"Create Department","id":"00d6b320-09b2-4c25-ad55-d112bd25289a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Department Test\"\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/departments","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Required	Description	Type / format	Example
name	Yes	Department Name	`string`	`\"Department Test\"`

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
id	Department ID	`string`	`LaanR96PA3AzZ3eMG0Wb`

","urlObject":{"path":["companies","COMPANY_ID","departments"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[]}},"response":[{"id":"2f934ea5-90a3-43ca-90b5-d6bbc0fb19ee","name":"Create Department","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Department Test\"\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/departments"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"LaanR96PA3AzZ3eMG0Wb\"\n}"}],"_postman_id":"00d6b320-09b2-4c25-ad55-d112bd25289a"},{"name":"Update Department","id":"067b56e9-30e3-41be-8c1f-845be9b33682","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Department Test\",\n \"isDeleted\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/departments/:departmentID","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Required	Description	Type / format	Example
name	No	Department Name	`string`	`\"Department Test\"`
isDeleted	No	Check if the Department was deleted	`boolean`	`true`

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
id	Department ID	`string`	`LaanR96PA3AzZ3eMG0Wb`
name	Department Name	`string`	`Department Test`
isDeleted	Is Department Deleted	`boolean`	`true`
createTime	When Department was Created	an ISO 8601 encoded `string`	`2024-02-23T17:00:57.472Z`
updateTime	When Department was Updated	an ISO 8601 encoded `string`	`2024-02-23T17:00:57.472Z`

","urlObject":{"path":["companies","COMPANY_ID","departments",":departmentID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"type":"any","value":"","key":"departmentID"}]}},"response":[{"id":"d26a3cb2-bf66-47cb-a468-801aeeb18f80","name":"Update Department","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Department Test\",\n \"isDeleted\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/departments/:departmentID","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","departments",":departmentID"],"variable":[{"key":"departmentID","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"LaanR96PA3AzZ3eMG0Wb\",\n \"name\": \"Department Test\",\n \"isDeleted\": true,\n \"createTime\": \"2024-02-23T17:00:57.472Z\",\n \"updateTime\": \"2024-02-23T17:02:14.952Z\"\n}"}],"_postman_id":"067b56e9-30e3-41be-8c1f-845be9b33682"}],"id":"97f1a306-598a-40ae-9f50-d9986e147737","_postman_id":"97f1a306-598a-40ae-9f50-d9986e147737","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","name":"Workfeed API (prod)","type":"collection"}}},{"name":"Leaves","item":[{"name":"Create leave","id":"a9c17938-abef-4d55-99ee-0f07d4fc3953","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/leaves","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Required	Description	Type / Format	Example
start	Yes	When Leave starts. NB: Must be midnight in company time zone.	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`
end	Yes	When Leave ends. NB: Must be midnight in company time zone.	an ISO 8601 encoded `string`	`2023-10-25T12:43:06.650Z`
type	Yes	ID of the Leave Type.	`string` Either one of the default leave types `\"sick\"`, `\"holiday\"`, and `\"comp_time\"` OR the ID of a custom leave type.	`holiday`
unpaid	Yes	Whether the Leave is Paid or Unpaid NB: Leaves with type `comp_time` must be paid	`boolean`	`true`
employeeID	Yes	Employee associated to the Leave	`string`	`sEx78CyrI2M9RDfsN99BL78BUKx2`
note	No	Leave Note	`string`	`Leave note 📝`

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
id	ID of created Leave	`string`	{ \"id\": \"\" }

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","name":"Workfeed API (prod)","type":"collection"}},"urlObject":{"path":["companies","COMPANY_ID","leaves"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[]}},"response":[{"id":"cb6b211b-cb46-4ad7-aed6-f51f49122828","name":"Create leave","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"start\": \"2025-03-15T19:00:00.000Z\",\n \"end\": \"2025-03-15T19:00:00.000Z\",\n \"employeeID\": \"EMPLOYEE_ID\",\n \"type\": \"holiday\",\n \"unpaid\": false,\n \"note\": \"Leave note 📝\"\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/leaves"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"LEAVE_ID\"\n}"}],"_postman_id":"a9c17938-abef-4d55-99ee-0f07d4fc3953"},{"name":"Get Leave","id":"1e6e4423-4964-4854-8641-ef5cbdfb155d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/leaves/:leaveID","description":"

Response Fields

Body	Description	Type / Format	Example
id	Leave ID	`string`	`2023-12-21`
start	When Leave starts	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`
end	When Leave ends	an ISO 8601 encoded `string`	`2023-10-25T12:43:06.650Z`
employeeID	Employee associated to the Shift	`string` / `null`	`sEx78CyrI2M9RDfsN99BL78BUKx2`
allDay	Is Leave all day?	`boolean`	`true`
note	Leave Note	`string` / `null`	`null`
unpaid	Is Leave Paid or Unpaid ?	`boolean`	`true`
leaveRequestID	Request ID	`string` / `null`	`null`
leaveType	Leave Type	`object`
leaveType.id	Leave Type ID	`string`	`holiday`
leaveType.emoji	Leave Type Emoji	`string`	`🌴`
leaveType.name	Leave Type Name	`string`	`shared.holiday`
leaveType.color	Leave Type Color	`string` in HEX format	`#07BE62`
leaveType.isDeleted	Is Leave Type deleted ?	`boolean`	`false`
createTime	When the Daily Note was created	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`
updateTime	When the Daily Note was updated	an ISO 8601 encoded `string`	2023-10-25T09:43:06.650Z

","urlObject":{"path":["companies","COMPANY_ID","leaves",":leaveID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"id":"ba582aa3-40b8-411b-9856-60ad1ad19b76","description":{"content":"

Leave ID

\n","type":"text/plain"},"type":"any","value":"","key":"leaveID"}]}},"response":[{"id":"5f827f3b-a6b6-47bb-a1ec-21a5fa338ea3","name":"Get Leave","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/leaves/:leaveID","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","leaves",":leaveID"],"variable":[{"key":"leaveID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"meo6wBYbAlDMWPIEQPtS\",\n \"start\": \"2024-01-24T00:00:00.000Z\",\n \"end\": \"2024-01-24T00:00:00.000Z\",\n \"employeeID\": \"sEx78CyrI2M9RDfsN99BL78BUKx2\",\n \"allDay\": true,\n \"note\": \"\",\n \"unpaid\": false,\n \"leaveRequestID\": null,\n \"leaveType\": {\n \"id\": \"holiday\",\n \"emoji\": \"🌴\",\n \"name\": \"shared.holiday\",\n \"color\": \"#07BE62\",\n \"isDeleted\": false\n },\n \"createTime\": \"2024-01-22T08:36:17.450Z\",\n \"updateTime\": \"2024-01-22T08:41:51.088Z\"\n}"}],"_postman_id":"1e6e4423-4964-4854-8641-ef5cbdfb155d"},{"name":"Get Leaves","id":"b766e6aa-42e3-46e5-9b62-4647eacd7dfe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/leaves/?from&to","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Required	Description	Type / format	Example
from	Yes	Only get Leaves starting on or after this time	an ISO 8601 encoded `string`	`2023-07-01T00:00:00.000Z`
to	Yes	Only get Leaves starting before this time	an ISO 8601 encoded `string`	`2023-10-30T00:00:00.000Z`
employeeIDs	No	Filter by one or more employee IDs. Repeat the param to pass multiple values.	`string` (repeatable)	`&employeeIDs=abc&employeeIDs=def`
typeIDs	No	Filter by one or more leave type IDs. Accepts standard types (`holiday`, `sick`, `comp_time`) and custom leave type IDs. Returns `400` if an invalid ID is provided. Repeat the param to pass multiple values.	`string` (repeatable)	`&typeIDs=holiday&typeIDs=sick`
includeDeleted	No	Include leaves whose leave type has been deleted. Defaults to `true`.	`\"true\"` \| `\"false\"`	`false`

Response Fields

Body	Description	Type / Format	Example
id	Leave ID	`string`	`2023-12-21`
start	When Leave starts	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`
end	When Leave ends	an ISO 8601 encoded `string`	`2023-10-25T12:43:06.650Z`
employeeID	Employee associated to the Leave	`string` / `null`	`sEx78CyrI2M9RDfsN99BL78BUKx2`
allDay	Is Leave all day?	`boolean`	`true`
note	Leave Note	`string` / `null`	`null`
unpaid	Is Leave Paid or Unpaid?	`boolean`	`true`
leaveRequestID	Request ID	`string` / `null`	`null`
leaveType	Leave Type	`object`
leaveType.id	Leave Type ID	`string`	`holiday`
leaveType.emoji	Leave Type Emoji	`string`	`🌴`
leaveType.name	Leave Type Name	`string`	`shared.holiday`
leaveType.color	Leave Type Color	`string` in HEX format	`#07BE62`
leaveType.isDeleted	Is Leave Type deleted?	`boolean`	`false`
createTime	When the Leave was created	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`
updateTime	When the Leave was updated	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`

","urlObject":{"path":["companies","COMPANY_ID","leaves",""],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[{"key":"from","value":null},{"key":"to","value":null}],"variable":[]}},"response":[{"id":"a0a8088a-8d2b-4446-92d6-7b744b2c96e7","name":"Get Leaves","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/leaves/?from&to","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","leaves",""],"query":[{"key":"from","value":null},{"key":"to","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"PbbUTTP1uLlDcrFbF7kk\",\n \"start\": \"2024-01-25T00:00:00.000Z\",\n \"end\": \"2024-01-25T00:00:00.000Z\",\n \"employeeID\": \"sEx78CyrI2M9RDfsN99BL78BUKx2\",\n \"allDay\": true,\n \"note\": \"\",\n \"unpaid\": false,\n \"leaveRequestID\": null,\n \"leaveType\": {\n \"color\": \"#85909F\",\n \"emoji\": \"🚩\",\n \"isDeleted\": false,\n \"name\": \"Test Type 1\",\n \"id\": \"FFBZabD16cVU5D6UsAdV\"\n },\n \"createTime\": \"2024-01-23T11:47:57.049Z\",\n \"updateTime\": \"2024-01-23T11:47:57.049Z\"\n },\n {\n \"id\": \"meo6wBYbAlDMWPIEQPtS\",\n \"start\": \"2024-01-24T00:00:00.000Z\",\n \"end\": \"2024-01-24T00:00:00.000Z\",\n \"employeeID\": \"sEx78CyrI2M9RDfsN99BL78BUKx2\",\n \"allDay\": true,\n \"note\": \"\",\n \"unpaid\": false,\n \"leaveRequestID\": null,\n \"leaveType\": {\n \"id\": \"holiday\",\n \"emoji\": \"🌴\",\n \"name\": \"shared.holiday\",\n \"color\": \"#07BE62\",\n \"isDeleted\": false\n },\n \"createTime\": \"2024-01-22T16:36:17.450Z\",\n \"updateTime\": \"2024-01-22T17:41:51.088Z\"\n }\n]"}],"_postman_id":"b766e6aa-42e3-46e5-9b62-4647eacd7dfe"},{"name":"Update leave","id":"b1cf5dc0-6320-442f-b5b4-0cc166f51ff4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/leaves/:leaveID","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
start	When Leave starts. NB: Must be midnight in company time zone.	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`
end	When Leave ends. NB: Must be midnight in company time zone.	an ISO 8601 encoded `string`	`2023-10-25T12:43:06.650Z`
type	ID of the Leave Type.	`string` Either one of the default leave types `\"sick\"`, `\"holiday\"`, and `\"comp_time\"` OR the ID of a custom leave type.	`holiday`
unpaid	Whether the Leave is Paid or Unpaid NB: Leaves with type `comp_time` must be paid	`boolean`	`true`
employeeID	Employee associated to the Leave	`string`	`sEx78CyrI2M9RDfsN99BL78BUKx2`
note	Leave Note	`string`	`Leave note 📝`

Response Fields

See Get Leave endpoint.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","name":"Workfeed API (prod)","type":"collection"}},"urlObject":{"path":["companies","COMPANY_ID","leaves",":leaveID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"type":"any","value":"","key":"leaveID"}]}},"response":[{"id":"23f2cbe7-75fd-46eb-9067-a82897eca009","name":"Update leave","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"start\": \"2025-03-15T19:00:00.000Z\",\n \"end\": \"2025-03-15T19:00:00.000Z\",\n \"employeeID\": \"EMPLOYEE_ID\",\n \"type\": \"holiday\",\n \"unpaid\": false,\n \"note\": \"Leave note 📝\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/leaves/:leaveID","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","leaves",":leaveID"],"variable":[{"key":"leaveID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"LEAVE_ID\",\n \"start\": \"2025-03-14T19:00:00.000Z\",\n \"end\": \"2025-04-14T19:00:00.000Z\",\n \"employeeID\": \"EMPLOYEE_ID\",\n \"allDay\": true,\n \"note\": \"Leave note 📝\",\n \"unpaid\": false,\n \"leaveRequestID\": null,\n \"leaveType\": {\n \"id\": \"holiday\",\n \"emoji\": \"🌴\",\n \"name\": \"shared.holiday\",\n \"color\": \"#07BE62\",\n \"isDeleted\": false\n },\n \"createTime\": \"2025-03-09T09:46:24.567Z\",\n \"updateTime\": \"2025-03-09T10:00:57.871Z\"\n}"}],"_postman_id":"b1cf5dc0-6320-442f-b5b4-0cc166f51ff4"},{"name":"Delete leave","id":"d36ed713-8570-4510-893e-8dc175c39a40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/leaves/:leaveID","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","name":"Workfeed API (prod)","type":"collection"}},"urlObject":{"path":["companies","COMPANY_ID","leaves",":leaveID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"type":"any","value":"","key":"leaveID"}]}},"response":[{"id":"eac3223a-ceba-439e-884c-b627190cbe13","name":"Delete leave","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/leaves/:leaveID","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","leaves",":leaveID"],"variable":[{"key":"leaveID","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d36ed713-8570-4510-893e-8dc175c39a40"}],"id":"67360baa-93aa-47b4-b432-7c6aa711da21","_postman_id":"67360baa-93aa-47b4-b432-7c6aa711da21","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","name":"Workfeed API (prod)","type":"collection"}}},{"name":"Roles","item":[{"name":"Get roles","id":"3ab1ea41-32ba-4bd4-8d4b-3c78323567ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/roles","description":"

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
id	Role ID	`string`	`hLbEKIPTlMh3ehotXl0w`
name	Role Name	`string`	`Role 1`
departmentID	Department linked to the Role	`string`	`PKHaOSgFA4uguOqmLfWv`
color	Role color	`string`	`role_color_1`
isDeleted	Check if the Role was deleted	`boolean`	`false`
createTime	When the Role was created	an ISO 8601 encoded `string`	`2023-10-25T09:43:35.666Z`
updateTime	When the Role was updated	an ISO 8601 encoded `string`	`2023-10-25T09:43:35.666Z`

","urlObject":{"path":["companies","COMPANY_ID","roles"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[]}},"response":[{"id":"08d67c07-0121-49f2-ad35-6985563e79d5","name":"Get roles","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/roles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"hLbEKIPTlMh3ehotXl0w\",\n \"name\": \"Role 1\",\n \"departmentID\": \"PKHaOSgFA4uguOqmLfWv\",\n \"isDeleted\": false,\n \"color\": \"role_color_1\",\n \"createTime\": \"2023-10-25T09:43:35.666Z\",\n \"updateTime\": \"2023-10-25T09:43:35.666Z\"\n }\n]"}],"_postman_id":"3ab1ea41-32ba-4bd4-8d4b-3c78323567ec"},{"name":"Create Role","id":"7293fccd-9baf-40a8-910c-0ebf8ddd8cb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Role Test\",\n \"departmentID\": \"PUTUCPpzdAzqcMxhfJZK\",\n \"color\": \"role_color_1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/roles","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Required	Description	Type / format	Example
name	true	Role Name	`string`	`Role Test`
departmentID	true	Department ID	`string`	`PUTUCPpzdAzqcMxhfJZK`
color	false	Role color `Options:` \"role_color_{number}\" number range = 1-21	`string`	`role_color_1`

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
id	Role ID	`string`	`hLbEKIPTlMh3ehotXl0w`

","urlObject":{"path":["companies","COMPANY_ID","roles"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[]}},"response":[{"id":"2acd9923-0358-418b-afb2-fe6755671dcb","name":"Create roles","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"API-KEY","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Role Test\",\n \"departmentID\": \"PUTUCPpzdAzqcMxhfJZK\",\n \"color\": \"role_color_1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/roles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"LRhJzE8cEFFTev6G1ez5\"\n}"}],"_postman_id":"7293fccd-9baf-40a8-910c-0ebf8ddd8cb3"},{"name":"Update Role","id":"50e80a58-66fd-471c-aa48-6fe70e776269","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Role Test\",\n \"color\": \"role_color_1\",\n \"isDeleted\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/roles/:roleID","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Required	Description	Type / format	Example
name	false	Role Name	`string`	`Role Test`
isDeleted	false	Check if Role was deleted	`boolean`	`true`
color	false	Role color `Options:` \"role_color_{number}\" number range = 1-21	`string`	`role_color_1`

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
id	Role ID	`string`	`LRhJzE8cEFFTev6G1ez5`
name	Role Name	`string`	`Role Test`
departmentID	Department linked to the Role	`string`	`PKHaOSgFA4uguOqmLfWv`
color	Role color	`string`	`role_color_1`
isDeleted	Check if the Role was deleted	`boolean`	`false`
createTime	When the Role was created	an ISO 8601 encoded `string`	`2023-10-25T09:43:35.666Z`
updateTime	When the Role was updated	an ISO 8601 encoded `string`	`2023-10-25T09:43:35.666Z`

","urlObject":{"path":["companies","COMPANY_ID","roles",":roleID"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[{"type":"any","value":"","key":"roleID"}]}},"response":[{"id":"d03208ff-3236-41dd-9c2d-2f7c39b2bcc7","name":"Update roles","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"API-KEY","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Role Test\",\n \"color\": \"role_color_1\",\n \"isDeleted\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/roles/:roleID","protocol":"https","host":["europe-west1-production-eu-327a3","cloudfunctions","net"],"path":["api","companies","COMPANY_ID","roles",":roleID"],"variable":[{"key":"roleID","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"LRhJzE8cEFFTev6G1ez5\",\n \"name\": \"Role Test\",\n \"departmentID\": \"PUTUCPpzdAzqcMxhfJZK\",\n \"isDeleted\": true,\n \"color\": \"role_color_1\",\n \"createTime\": \"2024-02-23T16:53:39.788Z\",\n \"updateTime\": \"2024-03-04T11:42:11.566Z\"\n}"}],"_postman_id":"50e80a58-66fd-471c-aa48-6fe70e776269"}],"id":"6dc8920b-9a55-40d5-86ba-f756ddf7e36e","_postman_id":"6dc8920b-9a55-40d5-86ba-f756ddf7e36e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]},"isInherited":true,"source":{"_postman_id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","name":"Workfeed API (prod)","type":"collection"}}},{"name":"Get settings","id":"b74780ec-66d2-4841-b253-6e8bd1cc3356","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/settings","description":"

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / Format	Example
salaryPeriodStartDate	Day of the month that the salary period / cycle starts. It’s only a `number` when `payPeriodSetting.frequency` is set to monthly	`number` / `null`	`null`
payPeriodSetting	Pay Period Setting	`object` / `null`	`null`
payPeriodSetting.startDate	First date of a salary period / cycle	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`
payPeriodSetting.frequency	Options: `\"weekly\"` / `\"biweekly\"` / `\"monthly\"`	`string` / `null`	`null`
shiftBreak	The company’s default shift break rules that applies to all shifts except for those with a custom break	`object`
shiftBreak.breakDuration	Duration in Hours	`number`	`1`
shiftBreak.shiftLengthInterval	Interval after which a break should be applied in hours	`number`	`2`
shiftBreak.breakType	Whether breaks stack incrementally or are fixed. `\"incremental\"` adds breaks as shift length increases, while `\"fixed\"` applies a single break after the interval	`string`	`\"incremental\"`
createTime	When the Settings was created	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`
updateTime	When the Settings was updated	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`

","urlObject":{"path":["companies","COMPANY_ID","settings"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[],"variable":[]}},"response":[{"id":"46331eb1-d7a2-4ed6-9e83-4cdafcbccc0d","name":"Get settings","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/settings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"salaryPeriodStartDate\": null,\n \"payPeriodSetting\": null,\n \"shiftBreak\": null,\n \"createTime\": null,\n \"updateTime\": null\n}"}],"_postman_id":"b74780ec-66d2-4841-b253-6e8bd1cc3356"},{"name":"Get availability","id":"139d6886-e1a8-4aca-8f0b-4813bd46c6f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/availability?from=2025-01-01T00:00:00.000Z&to=2026-01-01T00:00:00.000Z","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Required	Description	Type / format	Example
`from`	Yes	Date to query from	an ISO 8601 encoded `string`	`2022-04-07T22:00:00.000Z`
`to`	Yes	Date to query to	an ISO 8601 encoded `string`	`2022-04-10T22:00:00.000Z`
`employeeID`	No	If present, only get availability of the employee with this id	`string`	`j1TznpqVtLN0nmgPfK476U5fn2O2`
`type`	No	If present, only get availability of `type`	`string` / [\"WORK\", \"NO_WORK\"]	`WORK`

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Description	Type / format	Example
id	Availability ID	`string`	`Trcu7MKFomu5y5zv1B8G`
start	When Availability starts	an ISO 8601 encoded `string`	`2023-10-23T08:00:00.000Z`
end	When Availability ends	an ISO 8601 encoded `string`	`2023-10-23T16:00:00.000Z`
employeeID	Employee associated to the Shift	`string`	`j1TznpqVtLN0nmgPfK476U5fn2O2`
type	Type of availability	`string` / [\"WORK\", \"NO_WORK\"]	`WORK`
createTime	When Availability was created	an ISO 8601 encoded `string`	`2023-10-27T09:10:30.336Z`
updateTime	When Availability was updated	an ISO 8601 encoded `string`	`2023-10-27T09:10:30.336Z`

","urlObject":{"path":["companies","COMPANY_ID","availability"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[{"description":{"content":"

Date to query from

\n","type":"text/plain"},"key":"from","value":"2025-01-01T00:00:00.000Z"},{"description":{"content":"

Date (ISO String) to query to

\n","type":"text/plain"},"key":"to","value":"2026-01-01T00:00:00.000Z"},{"disabled":true,"description":{"content":"

Employee ID

\n","type":"text/plain"},"key":"employeeID","value":""},{"disabled":true,"description":{"content":"

Type of availability to query

\n","type":"text/plain"},"key":"type","value":"WORK"}],"variable":[]}},"response":[{"id":"b5acdf6e-1363-49ba-8ad6-aa85451bd4d0","name":"by date range","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/availability?from=2025-01-01T00:00:00.000Z&to=2026-01-01T00:00:00.000Z","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","availability"],"query":[{"key":"from","value":"2025-01-01T00:00:00.000Z","description":"Date (ISO String) to query from"},{"key":"to","value":"2026-01-01T00:00:00.000Z","description":"Date (ISO String) to query to"},{"key":"employeeID","value":"2gpytsnr0MZIFJsqpFCTLZVbzpw2","description":"Employee ID","disabled":true},{"key":"type","value":"WORK","description":"Type of availability to query","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"etag","value":"W/\"562-Wgm7FljfwYYEpwRKZMrNITU3gAk\""},{"key":"function-execution-id","value":"1l9c59gnnmas"},{"key":"x-cloud-trace-context","value":"4537ef04ca19aa8f43d458b01ca74c55;o=1"},{"key":"date","value":"Tue, 14 Oct 2025 11:54:02 GMT"},{"key":"server","value":"Google Frontend"},{"key":"Content-Length","value":"1378"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"NFKXPKccoWARsAnJw6Rx\",\n \"start\": \"2025-10-19T22:00:00.000Z\",\n \"end\": \"2025-10-20T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"NO_WORK\",\n \"createTime\": \"2025-10-13T08:17:56.238Z\",\n \"updateTime\": \"2025-10-13T08:17:56.238Z\"\n },\n {\n \"id\": \"5xrgPQYBwgB548is1OOI\",\n \"start\": \"2025-10-20T22:00:00.000Z\",\n \"end\": \"2025-10-21T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"WORK\",\n \"createTime\": \"2025-10-13T08:17:57.243Z\",\n \"updateTime\": \"2025-10-13T08:17:57.383Z\"\n },\n {\n \"id\": \"mfBcP9vIUssxIz820AFh\",\n \"start\": \"2025-10-21T22:00:00.000Z\",\n \"end\": \"2025-10-22T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"NO_WORK\",\n \"createTime\": \"2025-10-13T08:17:58.165Z\",\n \"updateTime\": \"2025-10-13T08:17:59.042Z\"\n },\n {\n \"id\": \"Yb45RUexcdn87HQtLR8t\",\n \"start\": \"2025-10-22T22:00:00.000Z\",\n \"end\": \"2025-10-23T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"NO_WORK\",\n \"createTime\": \"2025-10-13T08:17:59.924Z\",\n \"updateTime\": \"2025-10-13T08:17:59.924Z\"\n },\n {\n \"id\": \"aj4cise0xdUWgzEhCdvu\",\n \"start\": \"2025-10-23T22:00:00.000Z\",\n \"end\": \"2025-10-24T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"WORK\",\n \"createTime\": \"2025-10-13T08:18:00.363Z\",\n \"updateTime\": \"2025-10-13T08:18:00.508Z\"\n },\n {\n \"id\": \"aW2v4LaltEQiCD6kWnNM\",\n \"start\": \"2025-10-24T22:00:00.000Z\",\n \"end\": \"2025-10-25T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"WORK\",\n \"createTime\": \"2025-10-13T08:18:01.136Z\",\n \"updateTime\": \"2025-10-13T08:18:01.284Z\"\n }\n]"},{"id":"bd917efd-9ef3-4e7e-943f-8dad71636a46","name":"by date range & employeeID","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/availability?from=2025-01-01T00:00:00.000Z&to=2026-01-01T00:00:00.000Z&employeeID=OC9CjKD4ECW2Y0thJLGk","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","availability"],"query":[{"key":"from","value":"2025-01-01T00:00:00.000Z","description":"Date (ISO String) to query from"},{"key":"to","value":"2026-01-01T00:00:00.000Z","description":"Date (ISO String) to query to"},{"key":"employeeID","value":"OC9CjKD4ECW2Y0thJLGk","description":"Employee ID"},{"key":"type","value":"NO_WORK","description":"Type of availability to query","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"etag","value":"W/\"562-Wgm7FljfwYYEpwRKZMrNITU3gAk\""},{"key":"function-execution-id","value":"1l9cyiunewvm"},{"key":"x-cloud-trace-context","value":"daf15dcd3561fcc102607a2862e8fa6c;o=1"},{"key":"date","value":"Tue, 14 Oct 2025 11:54:52 GMT"},{"key":"server","value":"Google Frontend"},{"key":"Content-Length","value":"1378"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"NFKXPKccoWARsAnJw6Rx\",\n \"start\": \"2025-10-19T22:00:00.000Z\",\n \"end\": \"2025-10-20T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"NO_WORK\",\n \"createTime\": \"2025-10-13T08:17:56.238Z\",\n \"updateTime\": \"2025-10-13T08:17:56.238Z\"\n },\n {\n \"id\": \"5xrgPQYBwgB548is1OOI\",\n \"start\": \"2025-10-20T22:00:00.000Z\",\n \"end\": \"2025-10-21T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"WORK\",\n \"createTime\": \"2025-10-13T08:17:57.243Z\",\n \"updateTime\": \"2025-10-13T08:17:57.383Z\"\n },\n {\n \"id\": \"mfBcP9vIUssxIz820AFh\",\n \"start\": \"2025-10-21T22:00:00.000Z\",\n \"end\": \"2025-10-22T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"NO_WORK\",\n \"createTime\": \"2025-10-13T08:17:58.165Z\",\n \"updateTime\": \"2025-10-13T08:17:59.042Z\"\n },\n {\n \"id\": \"Yb45RUexcdn87HQtLR8t\",\n \"start\": \"2025-10-22T22:00:00.000Z\",\n \"end\": \"2025-10-23T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"NO_WORK\",\n \"createTime\": \"2025-10-13T08:17:59.924Z\",\n \"updateTime\": \"2025-10-13T08:17:59.924Z\"\n },\n {\n \"id\": \"aj4cise0xdUWgzEhCdvu\",\n \"start\": \"2025-10-23T22:00:00.000Z\",\n \"end\": \"2025-10-24T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"WORK\",\n \"createTime\": \"2025-10-13T08:18:00.363Z\",\n \"updateTime\": \"2025-10-13T08:18:00.508Z\"\n },\n {\n \"id\": \"aW2v4LaltEQiCD6kWnNM\",\n \"start\": \"2025-10-24T22:00:00.000Z\",\n \"end\": \"2025-10-25T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"WORK\",\n \"createTime\": \"2025-10-13T08:18:01.136Z\",\n \"updateTime\": \"2025-10-13T08:18:01.284Z\"\n }\n]"},{"id":"3734b9bd-5f99-44ca-b033-e21c2358564f","name":"by date range & type (WORK)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/availability?from=2025-01-01T00:00:00.000Z&to=2026-01-01T00:00:00.000Z&type=WORK","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","availability"],"query":[{"key":"from","value":"2025-01-01T00:00:00.000Z","description":"Date (ISO String) to query from"},{"key":"to","value":"2026-01-01T00:00:00.000Z","description":"Date (ISO String) to query to"},{"key":"employeeID","value":"OC9CjKD4ECW2Y0thJLGk","description":"Employee ID","disabled":true},{"key":"type","value":"WORK","description":"Type of availability to query","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"etag","value":"W/\"2ad-+3xCrTz4/mrvZ4YccWBHJq4ERK0\""},{"key":"function-execution-id","value":"1l9c2ee10lk0"},{"key":"x-cloud-trace-context","value":"906032247339d024862eed88fc04ffcb;o=1"},{"key":"date","value":"Tue, 14 Oct 2025 11:55:57 GMT"},{"key":"server","value":"Google Frontend"},{"key":"Content-Length","value":"685"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"5xrgPQYBwgB548is1OOI\",\n \"start\": \"2025-10-20T22:00:00.000Z\",\n \"end\": \"2025-10-21T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"WORK\",\n \"createTime\": \"2025-10-13T08:17:57.243Z\",\n \"updateTime\": \"2025-10-13T08:17:57.383Z\"\n },\n {\n \"id\": \"aj4cise0xdUWgzEhCdvu\",\n \"start\": \"2025-10-23T22:00:00.000Z\",\n \"end\": \"2025-10-24T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"WORK\",\n \"createTime\": \"2025-10-13T08:18:00.363Z\",\n \"updateTime\": \"2025-10-13T08:18:00.508Z\"\n },\n {\n \"id\": \"aW2v4LaltEQiCD6kWnNM\",\n \"start\": \"2025-10-24T22:00:00.000Z\",\n \"end\": \"2025-10-25T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"WORK\",\n \"createTime\": \"2025-10-13T08:18:01.136Z\",\n \"updateTime\": \"2025-10-13T08:18:01.284Z\"\n }\n]"},{"id":"90f7f459-c849-487b-95ef-73fdd3c4bf60","name":"by date range, employeeID & type (WORK)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/availability?from=2025-01-01T00:00:00.000Z&to=2026-01-01T00:00:00.000Z&employeeID=OC9CjKD4ECW2Y0thJLGk&type=WORK","host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"path":["companies","COMPANY_ID","availability"],"query":[{"key":"from","value":"2025-01-01T00:00:00.000Z","description":"Date (ISO String) to query from"},{"key":"to","value":"2026-01-01T00:00:00.000Z","description":"Date (ISO String) to query to"},{"key":"employeeID","value":"OC9CjKD4ECW2Y0thJLGk","description":"Employee ID"},{"key":"type","value":"WORK","description":"Type of availability to query","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"etag","value":"W/\"562-Wgm7FljfwYYEpwRKZMrNITU3gAk\""},{"key":"function-execution-id","value":"1l9c0a90fayw"},{"key":"x-cloud-trace-context","value":"3dacb486e407ee60751d0ccd0e1a573e;o=1"},{"key":"date","value":"Tue, 14 Oct 2025 11:56:22 GMT"},{"key":"server","value":"Google Frontend"},{"key":"Content-Length","value":"1378"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"NFKXPKccoWARsAnJw6Rx\",\n \"start\": \"2025-10-19T22:00:00.000Z\",\n \"end\": \"2025-10-20T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"NO_WORK\",\n \"createTime\": \"2025-10-13T08:17:56.238Z\",\n \"updateTime\": \"2025-10-13T08:17:56.238Z\"\n },\n {\n \"id\": \"5xrgPQYBwgB548is1OOI\",\n \"start\": \"2025-10-20T22:00:00.000Z\",\n \"end\": \"2025-10-21T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"WORK\",\n \"createTime\": \"2025-10-13T08:17:57.243Z\",\n \"updateTime\": \"2025-10-13T08:17:57.383Z\"\n },\n {\n \"id\": \"mfBcP9vIUssxIz820AFh\",\n \"start\": \"2025-10-21T22:00:00.000Z\",\n \"end\": \"2025-10-22T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"NO_WORK\",\n \"createTime\": \"2025-10-13T08:17:58.165Z\",\n \"updateTime\": \"2025-10-13T08:17:59.042Z\"\n },\n {\n \"id\": \"Yb45RUexcdn87HQtLR8t\",\n \"start\": \"2025-10-22T22:00:00.000Z\",\n \"end\": \"2025-10-23T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"NO_WORK\",\n \"createTime\": \"2025-10-13T08:17:59.924Z\",\n \"updateTime\": \"2025-10-13T08:17:59.924Z\"\n },\n {\n \"id\": \"aj4cise0xdUWgzEhCdvu\",\n \"start\": \"2025-10-23T22:00:00.000Z\",\n \"end\": \"2025-10-24T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"WORK\",\n \"createTime\": \"2025-10-13T08:18:00.363Z\",\n \"updateTime\": \"2025-10-13T08:18:00.508Z\"\n },\n {\n \"id\": \"aW2v4LaltEQiCD6kWnNM\",\n \"start\": \"2025-10-24T22:00:00.000Z\",\n \"end\": \"2025-10-25T22:00:00.000Z\",\n \"employeeID\": \"OC9CjKD4ECW2Y0thJLGk\",\n \"type\": \"WORK\",\n \"createTime\": \"2025-10-13T08:18:01.136Z\",\n \"updateTime\": \"2025-10-13T08:18:01.284Z\"\n }\n]"}],"_postman_id":"139d6886-e1a8-4aca-8f0b-4813bd46c6f2"},{"name":"Get salary supplements","id":"0816e270-b20e-467f-a175-d7607e5adbeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/salary-supplements?Test","description":"

Response Fields

Body	Description	Type / Format	Example
add	`add.amount` represents the fixed amount that is the supplement’s value. Example: An amount of 2.5 would mean that an employee normally making $10 per hour would make $12.5 per hour in the supplement’s overlapping duration. `add.multiplier` represents the factor that should be multiplied onto the base wage of the employee when calculating the supplement’s value. Example: A multiplier of 1.5 would mean that an employee normally making $10 per hour would make $15 per hour in the supplement’s overlapping duration.	`object`
add.multiplier or add.amount	if `add.type` is set to `\"MULTIPLY\"` use `multiplier`. if `add.type` is set to `\"ADD\"` use `amount`	`number`	`1.5`
add.type	Options: `\"MULTIPLY\"` / `\"ADD\"`	`string`	`MULTIPLY`
code	External / Custom supplement identifier that will be sent to supported payroll providers when exporting	`string` / `null`	`null`
roles	The supplement will only be added to shifts with these roles Note: An empty array means all roles	`string[]`	`[]`
name	Supllement Name	`string`	`Test 1`
employees	The supplement will only be added to shifts with these employees. Note: An empty array means all employees	`string[]`	`[]`
type	Whether the supplement is a salary supplement (extra money for the employee) or a flex account supplement (extra hours for the employee). Options: `\"salary\"` / `\"flex\"`	`string`	`salary`
when	`when.start` and `when.end` represent the minutes of the day that this supplement is applied. Example: A start of 1140 and an end of 1380 means that the supplement will be applied to shifts taking place between 19 (1140/60) and 23 (1380/60). If a shift goes from 17 to 21, then this supplement would be applied for two hours. `when.overtime` represents the amount of hours worked before this supplements starts to be applied. Example: An overtime of 8 means that the employee gets their normal wage for the first 8 hours of their shift, and for any amount of time more than 8 hours, the supplement is applied	`object`
when.start or when.overtime	if `when.type` is set to `\"TIME_OF_DAY\"` use `start` & `end`. if `add.type` is set to `\"OVERTIME\"` use only `overtime`	`number`	`0`
when.end or when.overtime	if `when.type` is set to `\"TIME_OF_DAY\"` use `start` & `end`. if `add.type` is set to `\"OVERTIME\"` use only `overtime`	`number`	`1440`
when.type	Options: `TIME_OF_DAY` / `OVERTIME`	`string`	`TIME_OF_DAY`
id	Salary Supplement ID	`string`	`RkSiKGGoAI0uS0CnyDBm`
weekdays	What Weekdays does the Salary Supplement apply. If Holidays is set this field will be null	`object` / `null`
weekdays.shared.monday	Monday	`boolean`	`false`
weekdays.shared.tuesday	Tuesday	`boolean`	`false`
weekdays.shared.wednesday	Wednesday	`boolean`	`false`
weekdays.shared.thursday	Thrusday	`boolean`	`true`
weekdays.shared.friday	Friday	`boolean`	`true`
weekdays.shared.saturday	Saturday	`boolean`	`false`
weekdays.shared.sunday	Sunday	`boolean`	`true`
holidays	What Holidays does the Salary Supplement apply. If Weekdays is set this field will be null. Holiday boolean values are going to differ depending on which country you selected in the UI	`object` / `null`	`null`
holidays.good-friday		`boolean`	`true`
holidays.ascension-day		`boolean`	`true`
holidays.whit-monday		`boolean`	`false`
holidays.easter-monday		`boolean`	`true`
holidays.great-prayer-day		`boolean`	`false`
holidays.whit-sunday		`boolean`	`false`
holidays.easter-sunday		`boolean`	`true`
holidays.new-years-day		`boolean`	`true`
holidays.maundy-thursday		`boolean`	`false`
holidays.boxing-day		`boolean`	`false`
holidays.christmas-da		`boolean`	`true`
createTime	When the Salary Supplement was created	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`
updateTime	When the Salary Supplement was updated	an ISO 8601 encoded `string`	`2023-10-25T09:43:06.650Z`

","urlObject":{"path":["companies","COMPANY_ID","salary-supplements"],"host":["https://europe-west1-production-eu-327a3.cloudfunctions.net/api"],"query":[{"key":"Test","value":null}],"variable":[]}},"response":[{"id":"b862bc33-a28c-4a40-bc57-af6cea066cee","name":"Get salary supplements","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API-KEY","type":"text"}],"url":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api/companies/COMPANY_ID/salary-supplements"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"add\": {\n \"multiplier\": 1.5,\n \"type\": \"MULTIPLY\"\n },\n \"code\": null,\n \"roles\": [],\n \"name\": \"Test 1\",\n \"id\": \"RkSiKGGoAI0uS0CnyDBm\",\n \"employees\": [],\n \"type\": \"salary\",\n \"when\": {\n \"start\": 0,\n \"end\": 1440,\n \"type\": \"TIME_OF_DAY\"\n },\n \"holidays\": {\n \"holidays.good-friday\": true,\n \"holidays.ascension-day\": true,\n \"holidays.whit-monday\": true,\n \"holidays.easter-monday\": true,\n \"holidays.great-prayer-day\": true,\n \"holidays.whit-sunday\": true,\n \"holidays.easter-sunday\": true,\n \"holidays.new-years-day\": true,\n \"holidays.maundy-thursday\": true,\n \"holidays.boxing-day\": true,\n \"holidays.christmas-day\": true\n },\n \"weekdays\": null,\n \"createTime\": \"2023-11-10T14:21:15.965Z\",\n \"updateTime\": \"2023-11-10T14:54:02.144Z\"\n },\n {\n \"add\": {\n \"amount\": 20,\n \"type\": \"ADD\"\n },\n \"code\": null,\n \"roles\": [],\n \"name\": \"Test 2\",\n \"id\": \"e3tH8K52bskZ3vV6m5eM\",\n \"employees\": [],\n \"type\": \"salary\",\n \"when\": {\n \"overtime\": 0,\n \"type\": \"OVERTIME\"\n },\n \"weekdays\": {\n \"shared.sunday\": false,\n \"shared.friday\": false,\n \"shared.thursday\": false,\n \"shared.wednesday\": true,\n \"shared.tuesday\": false,\n \"shared.saturday\": false,\n \"shared.monday\": false\n },\n \"holidays\": null,\n \"createTime\": \"2023-11-10T14:22:37.938Z\",\n \"updateTime\": \"2023-11-10T14:23:15.051Z\"\n },\n {\n \"add\": {\n \"multiplier\": 1.5,\n \"type\": \"MULTIPLY\"\n },\n \"code\": null,\n \"roles\": [],\n \"name\": \"Test 3\",\n \"id\": \"kHHSNZBzqTt2lmdMCUUr\",\n \"type\": \"salary\",\n \"employees\": [\n \"SqkYFjKDOAVSDwRHZbE4T340cD73\"\n ],\n \"when\": {\n \"start\": 0,\n \"end\": 1440,\n \"type\": \"TIME_OF_DAY\"\n },\n \"holidays\": {\n \"holidays.good-friday\": true,\n \"holidays.ascension-day\": true,\n \"holidays.whit-monday\": true,\n \"holidays.easter-monday\": true,\n \"holidays.great-prayer-day\": true,\n \"holidays.whit-sunday\": true,\n \"holidays.easter-sunday\": true,\n \"holidays.new-years-day\": true,\n \"holidays.maundy-thursday\": true,\n \"holidays.boxing-day\": true,\n \"holidays.christmas-day\": true\n },\n \"weekdays\": null,\n \"createTime\": \"2023-11-10T14:41:30.650Z\",\n \"updateTime\": \"2023-11-10T14:54:59.047Z\"\n }\n]"}],"_postman_id":"0816e270-b20e-467f-a175-d7607e5adbeb"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API_KEY"}]}},"event":[{"listen":"prerequest","script":{"id":"315bb47b-83f3-48f4-b288-53b8ee17a3cf","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"b2fca44f-db9f-41cc-9104-c8f79cfe988c","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"baseURL","value":"https://europe-west1-production-eu-327a3.cloudfunctions.net/api"},{"key":"companyID","value":"COMPANY_ID"},{"key":"apiKey","value":"API_KEY"}]}