API Overview

You can create your own front end with the help of the CO3 API or you can create connection with other “satellite” systems. The API allows you to read data from and publish to CO3.

The CO3 API is a mostly RESTful API. Known caveats:

  • All API calls should be made with HTTP POST.
  • You can consider any non-200 HTTP response code an error – the returned data will contain more detailed information
  • API supports SSL connections only

Passing Request Data

Request data is passed to the API by POSTing XML objects to the API endpoints with the appropriate structure. The documentation for each API call will contain more details on the parameters accepted by the call.

Output Format

API supports XML output format only.

Handling errors

If CO3 is having trouble, you might get an error code with an error description. It’s your responsibility in all of these cases to correct and retry your request later.

Rate limiting

You can perform 2 requests per 1 second period from the same IP address for the same account. If you exceed this limit, you’ll get a Too Many Requests response.

Ready for use

API supports the following CO3 plugins:

Help us make it better

Please tell us how we can make the API better. If you have a specific feature request or if you found a bug, please contact us here!

Comments are closed.