Getting Started
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:
| Code | Description |
|---|---|
200 | The request was successful |
400 | The request was invalid or cannot be served |
401 | The request requires user authentication |
403 | The server understood the request, but refuses to authorize it |
404 | The requested resource could not be found |
409 | Business logic error |
429 | Too many requests |
500 | The server encountered an unexpected condition which prevented it from fulfilling the request |
Getting Started
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:
| Code | Description |
|---|---|
200 | The request was successful |
400 | The request was invalid or cannot be served |
401 | The request requires user authentication |
403 | The server understood the request, but refuses to authorize it |
404 | The requested resource could not be found |
409 | Business logic error |
429 | Too many requests |
500 | The server encountered an unexpected condition which prevented it from fulfilling the request |