How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CustomerOS CustomerBASE API

The CustomerBASE API API from CustomerOS — 6 operation(s) for customerbase api.

CustomerOS CustomerBASE API is one of 11 APIs that CustomerOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CustomerBASE API. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 6 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.customeros.ai/.

6 operations 6 paths 15 schemas 1 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.customeros.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

CustomerOS CustomerBASE API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-CUSTOMER-OS-API-KEY (ApiKeyAuth).

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 1 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

CustomerBASE API 6
POST
/customerbase/v1/contacts
Create a new contact
body → 200201400401500
POST
/customerbase/v1/contacts/bulk
Create multiple contacts
body → 201207400401500
POST
/customerbase/v1/contacts/import
Import contacts from CSV
body → 201207400401415500
POST
/customerbase/v1/organizations
Create a new organization
body → 201206400401409500
GET
/customerbase/v1/organizations/{id}
Get organization details
1 param → 200206400401404500
PUT
/customerbase/v1/organizations/{id}/links/{externalSystem}/primary
Set primary external system ID
2 params body → 200400401404500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are customerbase.OrganizationRecord (11 properties), customerbase.CreateOrganizationRequest (7 properties), customerbase.BulkResponseMultipleErrors (4 properties), customerbase.BulkResponse (4 properties). Each schema is shown below with its type and property counts.

customerbase.ContactRecord
object
Request to create a contact
3 properties
customerbase.ExternalLink
object
External system link information
3 properties
rest.BaseResponse
object
Standard response structure for API operations
2 properties
customerbase.BulkSummary
object
Summary statistics for bulk operations
3 properties
customerbase.CreateOrganizationRequest
object
Request to create an organization
7 properties
customerbase.BulkErrorDetails
object
Error details for failed operations in bulk processing
2 properties
customerbase.ExternalSystemRecord
object
External system information and its relationship to an organization
4 properties
customerbase.OrganizationResponse
object
Response structure for single organization operations
3 properties
customerbase.BulkResponseMultipleErrors
object
Response structure for bulk operations with multiple error details
4 properties
customerbase.SingleContactResponse
object
Response structure for single contact operations
3 properties
customerbase.OrganizationRecord
object
Detailed organization information returned by API operations
11 properties
customerbase.ExternalSystemResponse
object
Response structure for external system operations
3 properties
customerbase.SetPrimaryExternalSystemIdRequest
object
Request to set or replace the primary external system ID
1 property
customerbase.BulkResponse
object
Response structure for bulk operations with single error detail
4 properties
customerbase.ContactsResponse
object
Response structure for multiple contact operations
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

customeros-customerbase-api-api-openapi.yml Raw ↑

Other APIs CustomerOS publishes across the network.

CustomerOS Website Tracker
CustomerOS GraphQL API
CustomerOS Billing API
CustomerOS Domains API
CustomerOS Email Verification API
CustomerOS Enrichment API
CustomerOS Flows API
CustomerOS IP Intelligence API
CustomerOS Mailboxes API
CustomerOS Outreach API
Where this information came from

This is an independent, third-party profile of CustomerOS CustomerBASE API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.