Show API Menu

Clientary API Introduction

Clientary provides an API for programmatic access to account data. API access is provided in a REST-like interface exposing Clientary resources in a JSON format. JSONP is currently not supported.

Please use the navigational links on the left to access the various resources exposed via our API.

API Tokens

API access comes with every Clientary account. Every user within an account has their own individual token. This allows Clientary to distinguish the user behind every API request for purposes of reporting this in the application. For example, when tracking time via the API, the staff user corresponding to the API Token is used within the application.

Getting your API Token
  1. Go to your user profile page. You can find this on the upper right corner after logging in.
  2. Click to "Generate API Token" to generate a unique token.

Please be aware that API usage must comply with our API Terms.

Basics

Authentication

Clientary API access is available only through SSL/HTTPS. All authentication is performed via HTTP Basic Auth. Your HTTP header must either contain application/json as an Accept type or you must suffix the resource URL with .json.

Setting up a sample request
  curl 'https://{yourdomain}.clientary.com/api/v2/invoices'
    -H 'Accept: application/json' -u {api-token}:{api-token}
Alternate example
  curl 'https://{yourdomain}.clientary.com/api/v2/invoices.json'
    -u {api-token}:{api-token}
POST example
  curl 'https://{yourdomain}.clientary.com/api/v2/clients' 
    -u {api-token}:{api-token} 
    -H 'Accept: application/json'
    -H 'Content-type: application/json' 
    -X POST -d '{"client": {"name": "foo"}}'

API Libraries

We encourage community contributions for wrapper libraries for the Clientary API.

If you have a wrapper in any language that you'd like to contribute, we'd love to link it here!

Questions?

We're happy to address any API questions at