API Reference
Every endpoint in the Customerscore.io REST API. All requests go to https://api.customerscore.io/api/v1 and require the customerscore-key header — see the API Introduction for authentication details.
Customers
| Method | Endpoint | Description |
|---|---|---|
POST | /customers | Bulk import and upsert customers |
POST | /customer | Create a single customer |
GET | /customer/{customerExternalId} | Retrieve one customer |
PUT | /customer/{customerExternalId} | Update one customer |
DELETE | /customer/{customerExternalId} | Delete one customer |
POST | /customers/search | Search customers by criteria |
Contacts
| Method | Endpoint | Description |
|---|---|---|
POST | /contacts | Bulk import and upsert contacts |
POST | /customer/{customerExternalId}/contact | Create a contact on a customer |
PUT | /customer/{customerExternalId}/contact/{contactExternalId} | Update a contact |
DELETE | /customer/{customerExternalId}/contact/{contactExternalId} | Delete a contact |
Bulk vs. single operations
The bulk endpoints (customer upload and contact upload) accept arrays and upsert by external_id, which makes them the right choice for recurring syncs. The single-resource endpoints are better for real-time updates triggered by one event in your application.