API
API Introduction

API Introduction

The Customerscore API is a RESTful API that allows you to programmatically import and manage customer data, contacts, and product usage metrics.

Base URL

All API requests should be made to:

https://api.customerscore.io/api/v1

Authentication

You need an API token (customerscore-key) to connect to our REST API. You can generate your token in the Customerscore.io application under the API settings (opens in a new tab) section.

⚠️

Keep your API token secret and store it in a safe place! Never expose it in client-side code, public repositories, or logs.

Request Header Requirements

Include the following headers in every API request:

Content-Type: application/json
customerscore-key: "your-generated-key"

Rate Limiting

The API enforces rate limits to ensure fair usage and maintain service stability.

LimitValue
Requests per minute500
Max request body size5 MB

Rate Limit Response

If you exceed the rate limit, you'll receive a 429 Too Many Requests response with a Retry-After header indicating the number of seconds to wait before retrying.