Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Customer.io Customers API

Look up customer profiles, search for customers, and retrieve customer attributes and activity data.

Customer.io Customers API is one of 23 APIs that Customer.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 9 operations across 8 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.customer.io/v1, https://api-eu.customer.io/v1.

9 operations 8 paths 5 schemas 1 DELETE5 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://track.customer.io
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Customer.io Customers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication using your App API key. Pass the key in the Authorization header as Bearer {appapikey}.

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 1 DELETE, 5 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Customers 9

Look up customer profiles, search for customers, and retrieve customer attributes and activity data.

GET
/customers
Search customers
searchCustomers 1 param → 200401
GET
/customers/{identifier}/attributes
Get customer attributes
getCustomerAttributes 1 param → 200401404
GET
/customers/{identifier}/segments
Get customer segments
getCustomerSegments 1 param → 200401404
GET
/customers/{identifier}/activities
Get customer activities
getCustomerActivities 1 param → 200401404
GET
/customers/{identifier}/messages
Get customer messages
getCustomerMessages 1 param → 200401404
PUT
/customers/{identifier}
Identify a customer
identifyCustomer 1 param body → 200401
DELETE
/customers/{identifier}
Delete a customer
deleteCustomer 1 param → 200401404
POST
/customers/{identifier}/suppress
Suppress a customer
suppressCustomer 1 param → 200401
POST
/customers/{identifier}/unsuppress
Unsuppress a customer
unsuppressCustomer 1 param → 200401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Message (7 properties), Activity (5 properties), Segment (5 properties), Customer (4 properties). Each schema is shown below with its type and property counts.

Message
object
A message that was sent to a customer.
7 properties
Segment
object
A customer segment in Customer.io.
5 properties
CustomerAttributes
object
An object containing customer attributes to set or update. Any key-value pairs included will be saved as attributes on the customer profile.
3 properties
Activity
object
An activity record representing an action in your workspace.
5 properties
Customer
object
A customer profile with attributes.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

customer-io-customers-api-openapi.yml Raw ↑

Other APIs Customer.io publishes across the network.

Customer.io Track API
Customer.io Activities API
Customer.io Alias API
Customer.io Batch API
Customer.io Broadcasts API
Customer.io Campaigns API
Customer.io Collections API
Customer.io Devices API
Customer.io Entity API
Customer.io Events API
Customer.io Exports API
Customer.io Group API