# Customermates Records API

**Canonical:** https://apis.io/apis/customermates-com/customermates-com-records-api/  
**Provider:** Customermates — https://apis.io/providers/customermates-com/  
**Base URL:** https://customermates.com/api  
**Documentation:** https://customermates.com/en/docs

Customermates Records API is one of 15 APIs that [Customermates](https://apis.io/providers/customermates-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include records. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The records API from Customermates — 16 operation(s) for records.

## Operations (16)

| Method | Path | Summary |
|---|---|---|
| POST | `/v1/records/identities/resolve` | Resolve exact channel identifiers to every accessible linked record |
| POST | `/v1/records/detail-layout/read` | Read personal record detail layout |
| POST | `/v1/records/detail-layout/save` | Save or reset personal record detail layout |
| POST | `/v1/records/activities` | Read the activity timeline through declared record paths |
| POST | `/v1/records/search` | Search accessible record types |
| POST | `/v1/records/export` | Export accessible records as a JSON document or an Excel workbook |
| POST | `/v1/records/import` | Import a same-workspace record document |
| POST | `/v1/records/preview-deletion` | Preview record deletion and cascading effects |
| POST | `/v1/model/preview` | Preview a configuration change |
| POST | `/v1/model/apply` | Apply a configuration change |
| POST | `/v1/records/read` | Read one record |
| POST | `/v1/records/query` | Query records |
| POST | `/v1/records/mutate` | Create, update, delete or link records |
| POST | `/v1/reports/query` | Aggregate record values at an explicit grain |
| POST | `/v1/model/discover` | Discover record types by name |
| POST | `/v1/model/read` | Read record types and their configuration |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/customermates-com/openapi/customermates-com-records-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/customermates-com/json-schema/customermates-com-routine-dto-schema-schema.json
- **JSONSchema** — https://artifacts.apis.io/customermates-com/json-schema/customermates-com-webhook-public-dto-schema-schema.json
- **JSONSchema** — https://artifacts.apis.io/customermates-com/json-schema/customermates-com-record-source-output-schema.json
- **JSONSchema** — https://artifacts.apis.io/customermates-com/json-schema/customermates-com-get-messaging-thread-result-schema-schema.json
- **JSONSchema** — https://artifacts.apis.io/customermates-com/json-schema/customermates-com-record-source-schema.json
- **JSONSchema** — https://artifacts.apis.io/customermates-com/json-schema/customermates-com-calculation-expression-output-schema.json

## Other Customermates APIs (12)

- [Customermates Addresses API](https://apis.io/apis/customermates-com/customermates-com-addresses-api/)
- [Customermates Data Views API](https://apis.io/apis/customermates-com/customermates-com-data-views-api/)
- [Customermates Files API](https://apis.io/apis/customermates-com/customermates-com-files-api/)
- [Customermates Knowledge Base API](https://apis.io/apis/customermates-com/customermates-com-knowledge-base-api/)
- [Customermates Members API](https://apis.io/apis/customermates-com/customermates-com-members-api/)
- [Customermates Messaging API](https://apis.io/apis/customermates-com/customermates-com-messaging-api/)
- [Customermates Operations API](https://apis.io/apis/customermates-com/customermates-com-operations-api/)
- [Customermates Record Links API](https://apis.io/apis/customermates-com/customermates-com-record-links-api/)
- [Customermates Roles API](https://apis.io/apis/customermates-com/customermates-com-roles-api/)
- [Customermates Routines API](https://apis.io/apis/customermates-com/customermates-com-routines-api/)
- [Customermates Trash API](https://apis.io/apis/customermates-com/customermates-com-trash-api/)
- [Customermates Users API](https://apis.io/apis/customermates-com/customermates-com-users-api/)

## Tags

records

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/customermates-com/customermates-com-records-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/customermates-com/.