Introduction

Welcome to the Curate API! You can use our API to retrieve and update the information in your account via third-party applications.

We have language bindings in Shell, Ruby, Python, and JavaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

Curate uses API tokens to allow you to access the API. You can register a new Curate API token in your settings page. Once You are in the settings page, locate the "API Tokens" tab to manage access to our API.

Before you can create an API token, you must enable the API for your account. Click the "Enable" button to grant the ability to utilize the API to your account.

Once you enable the API, you will be given the option to create an API token. You can create as many tokens as you please. We recommend creating a separate token for each application that you will be integrating with your account. Click on the "Create Application Token" button to have a token created for you. The access token will be presented for you on the screen. Please take note of the token, because once you close the box, we cannot display it for you again. If you loose your token, you will have to create a new one to grant access to another application.

Curate expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: Bearer [access-token]

Making Requests

/*
  Guzzle logic
  Curl Logic
*/

/*
  Axios Logic
  jQuery Logic
*/

All requests to the API require 2 headers:

• Authorization: Bearer [access-token]
• Content-Type: application/json

All requests are return as JSON.

Errors

The curate API uses the following error codes: