The Cliengo API

Welcome to the Cliengo developer hub. You'll find comprehensive guides and documentation to help you start working with Cliengo as quickly as possible, as well as support if you get stuck. Let's jump right in!

API Reference    Get Started

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 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, 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. If the command line isn’t your preference, a great alternative is POSTMAN, an easy-to-use Chrome extension for making HTTP requests.

Input/Output Format

Both request body data and response data are formatted as JSON.

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 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.

CORS

CORS, 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. 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.

Overview


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

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.