The Copper platform is equipped with a powerful API to provide integration with your applications. This documentation describes the composition and usage of available API endpoints.

OpenAPI Endpoints

Download the OpenAPI specification

Postman Collection

Download the Postman collection

​
Base URL

​
Date and Time Format

All date and time values in the Copper API are represented as timestamps in milliseconds since the Unix epoch (January 1, 1970, 00:00:00 UTC).

​
Numeric Values Format

All numeric values in the Copper API are returned as strings to prevent potential issues with floating-point precision.

​
Response Codes

The API returns standard HTTP response codes to indicate the success or failure of an API request. Here are a few examples:

CodeDescription
200The request was successful
400The request was invalid or cannot be served
401The request requires user authentication
403The server understood the request, but refuses to authorize it
404The requested resource could not be found
409Business logic error
429Too many requests
500The server encountered an unexpected condition which prevented it from fulfilling the request
Authentication