{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9d533476-bb62-4e09-8c42-6b80463cdfce","name":"Clockk API v1","description":"# IMPORTANT NOTES\n\nThis is our publically released API. We warrant that we will not remove any existing functionality in this API, however we may choose to add new functionality (endpoints, attributes and even new resources) at any point with no notice.\n\nYou must be a registered Clockk user to use Clockk’s API.\n\n## How Clockk hangs together\n\n**Customer** - Everything in Clockk hangs off the **customer** record. A **customer** has many seats, each of which is known as a **user**.\n\n**User** - A **user** is the primary model in Clockk, and is the only entity that can log in to Clockk. A user can be _archived_, meaning that user does not count toward the customer’s seat count.\n\n**Client** - A **customer** has many **clients**. A client is the entity whom you bill for your work. In Clockk, you cannot attach time to a **client**; only a **project**.\n\n**Project** - A **client** has many **projects**. **Projects** hold all manner of time, whether the time blocks (**artifact groups**) in the activity view or the time sheets (**time_sheets**) themselves.\n\n**Artifacts** are the atoms of work we know about, such as a file save or a web URL request. Artifacts don’t have their own entity\n\n**Artifact Group** - An **artifact group** (what we call a “time block” or “block” in the UI) holds **artifacts**. An **artifact group** has a _start_at_ time and an _end_at_ time, and belongs to a **project**.\n\n**Time sheets** - A **time sheet** is basically an empty structure (with little more than a _date_) connected to the **user** and **customer** that has multiple **time sheet entries**.\n\n**Time sheet entry** - A **time sheet entry** belongs to a **time sheet**, a **project** and a **client**. It has a _date_, a _duration_, and a _description_.\n\n## Accessing your data in Clockk\n\nClockk’s v1 API uses the [JSON:API](https://jsonapi.org) format. Clockk’s UI is written in [Ember.js](https://emberjs.com) which has first-class support for JSON:API. You too can have first-class JSON:API support even without using Ember.js. You can find implementations of the JSON:API format, for reading and writing in your favourite language at [https://jsonapi.org/implementations/.](https://jsonapi.org/implementations/.)\n\nAll resources are at `https://ca-central.api.clockk.com/api/v1/`. i.e. if you’re trying to access your projects, you’ll find them at `https://ca-central.api.clockk.com/api/v1/projects`.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"41624765","team":6928754,"collectionId":"9d533476-bb62-4e09-8c42-6b80463cdfce","publishedId":"2sAYdZuuJn","public":true,"publicUrl":"https://documenter-api.postman.tech/view/41624765/2sAYdZuuJn","privateUrl":"https://go.postman.co/documentation/41624765-9d533476-bb62-4e09-8c42-6b80463cdfce","customColor":{"top-bar":"FFFFFF","right-sidebar":"2b3f4f","highlight":"ff7e00"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/3d4ecf83-ab4d-4cd0-a167-97c00617a181/b3JhbmdlLW1hcmsucG5n","colors":{"top-bar":"2b3f4f","right-sidebar":"2b3f4f","highlight":"ff7e00"}},{"name":"light","logo":"https://content.pstmn.io/3d4ecf83-ab4d-4cd0-a167-97c00617a181/b3JhbmdlLW1hcmsucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"2b3f4f","highlight":"ff7e00"}}]}},"version":"8.10.1","publishDate":"2025-02-28T17:17:44.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/3d4ecf83-ab4d-4cd0-a167-97c00617a181/b3JhbmdlLW1hcmsucG5n","logoDark":"https://content.pstmn.io/3d4ecf83-ab4d-4cd0-a167-97c00617a181/b3JhbmdlLW1hcmsucG5n"}},"statusCode":200},"environments":[{"name":"Clockk API v1","id":"6bb05969-134f-4d60-960d-af32ab400b2a","owner":"41624765","values":[{"key":"accessToken","value":"«jwt token»","enabled":true,"type":"any"},{"key":"refreshToken","value":"«jwt token»","enabled":true,"type":"any"},{"key":"email","value":"","enabled":true,"type":"secret"},{"key":"password","value":"","enabled":true,"type":"secret"},{"key":"email","value":"","enabled":false,"type":"secret"},{"key":"password","value":"","enabled":false,"type":"secret"},{"key":"inviteEmail","value":"«invitee@domain.com»","enabled":true,"type":"default"},{"key":"userId","value":"«uuid»","enabled":true,"type":"any"},{"key":"customerId","value":"«uuid»","enabled":true,"type":"any"},{"key":"agentToken","value":"","enabled":true,"type":"any"},{"key":"seatInviteId","value":"«uuid»","enabled":true,"type":"any"},{"key":"clientId","value":"«uuid»","enabled":true,"type":"any"},{"key":"projectId","value":"«uuid»","enabled":true,"type":"any"},{"key":"firstTimeSheetEntryId","value":"","enabled":true,"type":"any"},{"key":"timeSheetId","value":"","enabled":true,"type":"any"}],"published":true}],"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/b1ee5b496d7050cb67c9e09086b4c5fd0b6c53af87e9c9e61f80476865e1023b","favicon":""},"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"},{"label":"Clockk API v1","value":"41624765-6bb05969-134f-4d60-960d-af32ab400b2a"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAYdZuuJn"}