{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"59bfbd79-56b8-4afc-ba02-aaa84928a576","name":"Workfeed API (prod)","description":"The Workfeed API is organised per company. Every endpoint lives under `/companies/{companyID}/...` and every request needs your API key.\n\n## Set it up once\n\nEvery request in this collection is built from **collection variables**, so you only fill these in once rather than editing each URL:\n\n| Variable | What to set it to |\n| --- | --- |\n| `baseURL` | `https://europe-west1-production-eu-327a3.cloudfunctions.net/api` |\n| `companyID` | Your company id |\n| `apiKey` | Your API key |\n\nRequests are stored as `{{baseURL}}/companies/{{companyID}}/shifts` — the URLs shown on this page are those variables already filled in, so you can read them as real URLs. **Fork or import the collection into Postman, set the three variables in the collection's Variables tab, and every request works immediately.**\n\n## Authentication\n\nSend the key in the `Authorization` header — no `Bearer` prefix, just the key:\n\n```\nAuthorization: 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\n```\n\n| Code | Meaning |\n| --- | --- |\n| `401` | `\"Not authenticated\"` — no `Authorization` header was sent |\n| `403` | `\"Not authorized. This API key does not have access to companyID <companyID>\"` — the key is valid but has no access to that company |\n\nThese two apply to every endpoint and are not repeated on the individual pages.\n\n## Conventions across the API\n\n*   **Timestamps** are ISO 8601 in UTC (`2026-03-12T09:00:00.000Z`). **Calendar days** are `yyyy-MM-dd` and are interpreted in the **company's** time zone, not yours. Availability endpoints go one step further and reject a timestamp without an offset.\n*   **Creating** returns `201` with the new id. **Updating** returns `200` with the full updated object. **Deleting** returns `204` with no body.\n*   **Errors** are a JSON string, not an object — a `400` body reads `\"Query param startFrom is missing\"`. The one exception is a `409` from the availability endpoints, which returns an object carrying the ids of the conflicting records.\n*   **Deletes are mostly permanent.** `DELETE` on a **shift, leave, transaction, table booking or availability** removes the document outright - it cannot be restored. **Tags** are the one exception and are soft-deleted via `deletedOn`. **Employees** have no delete endpoint at all; you soft-delete them by setting `deletedOn` through *Update employee*, and that cannot be undone through the API either.\n*   **Range queries are not uniform.** Each list endpoint documents its own comparison — some filter on start, some on end, some on overlap. Read the note on the endpoint rather than assuming.\n\n## Labor cost\n\nPer-shift `grossPay` is `0` for monthly-paid employees, so summing it across shifts understates cost. For a true daily total use **Get department stats**, which includes dynamic supplements and percentage-based extra costs.\n\n## Examples\n\nEvery endpoint carries at least one saved example, and the error cases are saved as examples too — pick them from the dropdown above the response pane. They all describe the same fictional company (Bistro Nord) so ids line up across endpoints.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11154454","team":960054,"collectionId":"59bfbd79-56b8-4afc-ba02-aaa84928a576","publishedId":"2s93eR3v2K","public":true,"publicUrl":"https://docs.workfeed.io","privateUrl":"https://go.postman.co/documentation/11154454-59bfbd79-56b8-4afc-ba02-aaa84928a576","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2f67ff"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/df1b6393-cafe-432b-8909-ab020a887a0b/d29ya2ZlZWRfbG9nb193b3JkbWFya19pbnZlcnRlZF9sYXJnZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"2f67ff"}},{"name":"light","logo":"https://content.pstmn.io/c63c008a-df14-4005-82a0-78a1287f4f5e/d29ya2ZlZWRfbG9nb193b3JkbWFya19mdWxsX2NvbG9yX2xhcmdlLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2f67ff"}}]}},"version":"8.12.7","publishDate":"2024-03-01T19:29:17.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/c63c008a-df14-4005-82a0-78a1287f4f5e/d29ya2ZlZWRfbG9nb193b3JkbWFya19mdWxsX2NvbG9yX2xhcmdlLnBuZw==","logoDark":"https://content.pstmn.io/df1b6393-cafe-432b-8909-ab020a887a0b/d29ya2ZlZWRfbG9nb193b3JkbWFya19pbnZlcnRlZF9sYXJnZS5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/c80083d308271119df348a297ea71b34f04ba1b5dd8afdec4a985581d53114d6","favicon":"https://res.cloudinary.com/postman/image/upload/v1709321706/team/ntmgqlqweyejmca9tpsf.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.workfeed.io/view/metadata/2s93eR3v2K"}