# CustomerOS REST API

**Canonical:** https://apis.io/apis/customeros/customeros-customerbase-rest-api/  
**Provider:** CustomerOS — https://apis.io/providers/customeros/  
**Base URL:** https://api.customeros.ai  
**Documentation:** https://github.com/customeros/customeros/tree/otter/packages/server/customer-os-api/docs

CustomerOS REST API is one of 4 APIs that [CustomerOS](https://apis.io/providers/customeros/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include REST, CustomerBase, Organization, Enrichment, and Email Verification. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

Key-authenticated REST surface for the customeros.ai cloud, published as six OpenAPI 3.0.1 documents (one per tag) plus the source Swagger 2.0 in github.com/customeros/customeros. All six declare the same ApiKeyAuth scheme, an X-CUSTOMER-OS-API-KEY header, and the same servers[] host https://api.customeros.ai. Access to each endpoint group is granted on a per-request basis by the CustomerOS team. NOTE: as of 2026-08-13 api.customeros.ai has no DNS address record, and the docs pages that used to document this API (docs.customeros.ai/api-overview and /api-descriptions) now return 404 — see lifecycle/customeros-lifecycle.yml.

## Machine-readable artifacts (10)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/customeros/refs/heads/main/openapi/customeros-customerbase-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/customeros/refs/heads/main/openapi/customeros-enrich-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/customeros/refs/heads/main/openapi/customeros-verify-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/customeros/refs/heads/main/openapi/customeros-domains-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/customeros/refs/heads/main/openapi/customeros-billing-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/customeros/refs/heads/main/openapi/customeros-outreach-openapi.yml
- **Swagger** — https://raw.githubusercontent.com/api-evangelist/customeros/refs/heads/main/openapi/_original/customeros-swagger.json
- **SourceCode** — https://github.com/customeros/customeros
- **Documentation** — https://docs.customeros.ai
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/customeros/refs/heads/main/apis.yml

## Other CustomerOS APIs (3)

- [CustomerOS Flow API](https://apis.io/apis/customeros/customeros-flow-api/)
- [CustomerOS Website Tracker](https://apis.io/apis/customeros/customeros-website-tracker/)
- [CustomerOS GraphQL API](https://apis.io/apis/customeros/customeros-graphql-api/)

## Tags

REST, CustomerBase, Organization, Enrichment, Email Verification, Mailstack, Billing

---

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