{"__v":53,"_id":"550bfb5622ccb01700a7946d","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Welcome to Timekit\",\n  \"body\": \"We'd love to hear what you're building! Throw us an email at [yourfriends:::at:::timekit.io](mailto:yourfriends@timekit.io) or chat with us (Intercom, lower right corner) and let's help you get off the ground together.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Getting started guides\",\n  \"body\": \"Make your first API calls and learn by example with our quickstart guides:\\n1) [Setup users & calendars](doc:guide-connect-and-setup-google-user)\\n2) [Availability search & find time](doc:guide-find-time-book-appointment)\\n3) [Creating & managing bookings](doc:guide-bookings)\"\n}\n[/block]\nThe Timekit API is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API is designed to follow common HTTP conventions including response codes to indicate both errors and successful requests. Standard HTTP verbs (GET, POST, PUT, DELETE) are used for all methods, no exceptions.\n\n[JSON](http://www.json.org/) will be returned in all responses from the API, including error messages.\n\n## Root endpoint, versions and protocol\n\nAll API calls should be made to `https://api.timekit.io/v2` (note the explicit versioning). The current public version of the API is **version 2** and is the only publicly supported version (calls to v1 will result in 404 Not Found). \n\nHTTP over TLS 1.2 is enforced for all calls, so non-secure calls will result in a 301 Moved Permanently pointing to the https URI.\n\n## CORS\n\nOur API is intended to be consumed both by browser clients (e.g. [SPA](http://en.wikipedia.org/wiki/Single-page_application)s) and servers and supports [cross-origin resource sharing](http://en.wikipedia.org/wiki/Cross-origin_resource_sharing). As of right now, JSONP is not supported, but we'd love to hear from you if it's of interest.\n\n## Application context\n\nWe provide a simple mechanism for tracking and bucketing app developers usage of the API by \"tagging\" all requests with an app ID. Read more about the application context [here](doc:application-context)\n\nFor demo purposes in the documentation, this value is always set to \"demo\" or \"docs\".\n\n## Uuid as ids\n\nAll ids used by Timekit are uuid. Uuid looks like this: **de305d54-75b4-431b-adb2-eb6b9e546014**\nRead more about uuids [here](https://en.wikipedia.org/wiki/Universally_unique_identifier)","category":"550bfb5622ccb01700a7946a","createdAt":"2015-03-19T14:16:51.119Z","excerpt":"This page will help you get started with Timekit. You'll be up and running in a jiffy!","githubsync":"","hidden":false,"isReference":true,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":0,"parentDoc":null,"project":"550ada512188a71900453199","slug":"getting-started","sync_unique":"","title":"Introduction","type":"basic","updates":[],"user":"550ada38cd78a42300ddf508","version":"550bfb5522ccb01700a79469","childrenPages":[]}

Introduction

This page will help you get started with Timekit. You'll be up and running in a jiffy!

[block:callout] { "type": "success", "title": "Welcome to Timekit", "body": "We'd love to hear what you're building! Throw us an email at [yourfriends@timekit.io](mailto:yourfriends@timekit.io) or chat with us (Intercom, lower right corner) and let's help you get off the ground together." } [/block] [block:callout] { "type": "info", "title": "Getting started guides", "body": "Make your first API calls and learn by example with our quickstart guides:\n1) [Setup users & calendars](doc:guide-connect-and-setup-google-user)\n2) [Availability search & find time](doc:guide-find-time-book-appointment)\n3) [Creating & managing bookings](doc:guide-bookings)" } [/block] The Timekit API is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API is designed to follow common HTTP conventions including response codes to indicate both errors and successful requests. Standard HTTP verbs (GET, POST, PUT, DELETE) are used for all methods, no exceptions. [JSON](http://www.json.org/) will be returned in all responses from the API, including error messages. ## Root endpoint, versions and protocol All API calls should be made to `https://api.timekit.io/v2` (note the explicit versioning). The current public version of the API is **version 2** and is the only publicly supported version (calls to v1 will result in 404 Not Found). HTTP over TLS 1.2 is enforced for all calls, so non-secure calls will result in a 301 Moved Permanently pointing to the https URI. ## CORS Our API is intended to be consumed both by browser clients (e.g. [SPA](http://en.wikipedia.org/wiki/Single-page_application)s) and servers and supports [cross-origin resource sharing](http://en.wikipedia.org/wiki/Cross-origin_resource_sharing). As of right now, JSONP is not supported, but we'd love to hear from you if it's of interest. ## Application context We provide a simple mechanism for tracking and bucketing app developers usage of the API by "tagging" all requests with an app ID. Read more about the application context [here](doc:application-context) For demo purposes in the documentation, this value is always set to "demo" or "docs". ## Uuid as ids All ids used by Timekit are uuid. Uuid looks like this: **de305d54-75b4-431b-adb2-eb6b9e546014** Read more about uuids [here](https://en.wikipedia.org/wiki/Universally_unique_identifier)