{"_id":"55aa7d993be8f60d00041d48","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"body":"## Content API Basics\nThe Cliengo Content API gives you access to the content management features you see in our web app and lets you extend them for use in your own app. It strives to be [RESTful](http://en.wikipedia.org/wiki/Representational_state_transfer) and is organized around the main resources you’re familiar with from the Cliengo web interface.\n\nBefore you do anything, you should create a free Cliengo account that you can test the API against and register for an API key so that you can make API calls.\n\n## Example Requests \nSample API calls are provided next to each method using [cURL](http://curl.haxx.se/), a standard command line tool. All you need to do is drop in your specific parameters, and you can test the calls from the command line. [Here is a great tutorial on using cURL with APIs](http://httpkit.com/resources/HTTP-from-the-Command-Line/). If the command line isn’t your preference, a great alternative is [POSTMAN](https://www.box.com/blog/using-postman-to-get-started-with-the-content-api-and-view-api-2/), an easy-to-use [Chrome extension](https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm/) for making HTTP requests. \n\n## Input/Output Format\nBoth request body data and response data are formatted as [JSON](http://www.json.org/). \n\n## Date Format\nAll timestamps (both those sent in requests and those returned in responses) should be formatted as shown in our examples. We support [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamps. The preferred way to pass in a date is by converting the time to UTC such as this: 2013-04-17T09:12:36-00:00\n\n## gzip\nIf you would like responses from Cliengo to be compressed for faster response times, simply include an ** Accept-Encoding** header with a value of **gzip, deflate** , and responses will be [gzipped](http://en.wikipedia.org/wiki/Gzip).\n\n## CORS\n[CORS](http://en.wikipedia.org/wiki/Cross-origin_resource_sharing), or cross-origin resource sharing, is a mechanism that allows a web page to make XMLHttpRequests to another domain (i.e. a domain different from the one it was loaded from). CORS is supported in a [specific set of modern browsers](http://caniuse.com/cors). The Cliengo API supports CORS.\n\n## Pagination\nEndpoints that return arrays support **limit** and **offset** as URL parameters. **Limit** defines the maximum number of records that will be returned on a page. The number of records is not guaranteed to be the number specified as visibility rules may filter out items. To avoid duplicates being returned we recommend the following logic:\n\n  * To retrieve the next page, set offset=offset+limit\n  * If total count from previous response is >= the new offset, you are done, no need to ask for another page\n\nNote that **offset** is zero based, defaults for **limit** vary by endpoint.\n\n## Upcoming Changes \nWe are always maintaining, fixing, and enhancing our API. As such, you should expect new endpoints to show up, new fields to be added to responses and new error codes to appear. We recommend that you build your code to gracefully ignore things that you aren’t expecting, and to handle errors in standard HTTP-centric ways.\n\n\n## Getting Help\nTo get in touch with our API experts directly, please submit a support ticket.\n\nFor community support, please use the cliengo-api tag on StackOverflow for any questions or suggestions.","createdAt":"2015-07-18T16:23:53.557Z","excerpt":"This page will help you get started with Cliengo. You'll be up and running in a minute!","hidden":false,"order":0,"project":"55aa7d973be8f60d00041d42","updates":[],"githubsync":"","title":"Overview","type":"basic","version":"55aa7d983be8f60d00041d45","__v":14,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"parentDoc":null,"sync_unique":"","user":"55aa7d625d3abb0d0012f3da","category":"55aa7d983be8f60d00041d46","isReference":false,"slug":"getting-started","childrenPages":[]}

Overview

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

## Content API Basics The Cliengo Content API gives you access to the content management features you see in our web app and lets you extend them for use in your own app. It strives to be [RESTful](http://en.wikipedia.org/wiki/Representational_state_transfer) and is organized around the main resources you’re familiar with from the Cliengo web interface. Before you do anything, you should create a free Cliengo account that you can test the API against and register for an API key so that you can make API calls. ## Example Requests Sample API calls are provided next to each method using [cURL](http://curl.haxx.se/), a standard command line tool. All you need to do is drop in your specific parameters, and you can test the calls from the command line. [Here is a great tutorial on using cURL with APIs](http://httpkit.com/resources/HTTP-from-the-Command-Line/). If the command line isn’t your preference, a great alternative is [POSTMAN](https://www.box.com/blog/using-postman-to-get-started-with-the-content-api-and-view-api-2/), an easy-to-use [Chrome extension](https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm/) for making HTTP requests. ## Input/Output Format Both request body data and response data are formatted as [JSON](http://www.json.org/). ## Date Format All timestamps (both those sent in requests and those returned in responses) should be formatted as shown in our examples. We support [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamps. The preferred way to pass in a date is by converting the time to UTC such as this: 2013-04-17T09:12:36-00:00 ## gzip If you would like responses from Cliengo to be compressed for faster response times, simply include an ** Accept-Encoding** header with a value of **gzip, deflate** , and responses will be [gzipped](http://en.wikipedia.org/wiki/Gzip). ## CORS [CORS](http://en.wikipedia.org/wiki/Cross-origin_resource_sharing), or cross-origin resource sharing, is a mechanism that allows a web page to make XMLHttpRequests to another domain (i.e. a domain different from the one it was loaded from). CORS is supported in a [specific set of modern browsers](http://caniuse.com/cors). The Cliengo API supports CORS. ## Pagination Endpoints that return arrays support **limit** and **offset** as URL parameters. **Limit** defines the maximum number of records that will be returned on a page. The number of records is not guaranteed to be the number specified as visibility rules may filter out items. To avoid duplicates being returned we recommend the following logic: * To retrieve the next page, set offset=offset+limit * If total count from previous response is >= the new offset, you are done, no need to ask for another page Note that **offset** is zero based, defaults for **limit** vary by endpoint. ## Upcoming Changes We are always maintaining, fixing, and enhancing our API. As such, you should expect new endpoints to show up, new fields to be added to responses and new error codes to appear. We recommend that you build your code to gracefully ignore things that you aren’t expecting, and to handle errors in standard HTTP-centric ways. ## Getting Help To get in touch with our API experts directly, please submit a support ticket. For community support, please use the cliengo-api tag on StackOverflow for any questions or suggestions.