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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
CustomerOS

CustomerOS Flows API

The Flows API from CustomerOS — 18 operation(s) for flows.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 34 operations across 18 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

34 operations 18 paths 26 schemas 7 DELETE15 GET2 PATCH7 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 34

Across 18 paths, the API surfaces 34 operations — 7 DELETE, 15 GET, 2 PATCH, 7 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Flows 34
GET
/flows
List all flows
→ 200
POST
/flows
Create a new flow
body → 201
GET
/flows/{flow_id}
Get details of a specific flow
1 param → 200
PATCH
/flows/{flow_id}
Update details of a specific flow
1 param body → 200
DELETE
/flows/{flow_id}
Delete a specific flow
1 param → 204
GET
/flows/{flow_id}/enable
Enable a flow
1 param → 200
GET
/flows/{flow_id}/disable
Disable a flow
1 param → 200
GET
/flows/{flow_id}/stats
Get stats for a flow
1 param → 200
GET
/flows/{flow_id}/sequences
List all sequences
1 param → 200
POST
/flows/{flow_id}/sequences
Create new sequence
1 param body → 201
GET
/flows/{flow_id}/sequences/{sequence_id}
Get details of a specific sequence
2 params → 200
PATCH
/flows/{flow_id}/sequences/{sequence_id}
Update details of a specific sequence
2 params body → 200
DELETE
/flows/{flow_id}/sequences/{sequence_id}
Delete a sequence
2 params → 204
POST
/flows/{flow_id}/sequences/{sequence_id}/enable
Enable a sequence
2 params → 200
POST
/flows/{flow_id}/sequences/{sequence_id}/disable
Disable a sequence
2 params → 200
GET
/flows/{flow_id}/sequences/{sequence_id}/stats
Get statistics for a specific sequence
2 params → 200
GET
/flows/{flow_id}/schedule
Get details of a specific sequence schedule
1 param → 200
PUT
/flows/{flow_id}/schedule
Update details of a specific sequence schedule
1 param body → 200
DELETE
/flows/{flow_id}/schedule
Delete details of a specific sequence schedule
1 param → 204
GET
/flows/{flow_id}/config
Get details of a specific sequence configuration
1 param → 200
PUT
/flows/{flow_id}/config
Update details of a specific sequence configuration
1 param body → 200
DELETE
/flows/{flow_id}/config
Delete details of a specific sequence configuration
1 param → 204
GET
/flows/{flow_id}/sequences/{sequence_id}/steps
List all steps for a sequence
2 params → 200
POST
/flows/{flow_id}/sequences/{sequence_id}/steps
Add a step to a sequence
2 params body → 201
GET
/flows/{flow_id}/sequences/{sequence_id}/steps/{step_id}
List details for a step in a sequence
3 params → 200
PUT
/flows/{flow_id}/sequences/{sequence_id}/steps/{step_id}
Update a step in a sequence
3 params body → 200
DELETE
/flows/{flow_id}/sequences/{sequence_id}/steps/{step_id}
Delete a step in a sequence
3 params → 204
GET
/flows/{flow_id}/senders
List all senders for a sequence
1 param → 200
POST
/flows/{flow_id}/senders
Add a sender to a sequence
1 param body → 201
DELETE
/flows/{flow_id}/senders/{sender_id}
Remove sender from a sequence
2 params → 204
GET
/flows/{flow_id}/sequences/{sequence_id}/contacts
List all contacts for a sequence
2 params → 200
POST
/flows/{flow_id}/sequences/{sequence_id}/contacts
Add contacts to a sequence
2 params body → 201
GET
/flows/{flow_id}/sequences/{sequence_id}/contacts/{contact_id}
Get details of a specific contact in a sequence
3 params → 200
DELETE
/flows/{flow_id}/sequences/{sequence_id}/contacts/{contact_id}
Remove a contact from a sequence
3 params → 204

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are Sender (11 properties), Contact (9 properties), SenderCreate (8 properties), Sequence (8 properties). Each schema is shown below with its type and property counts.

Flow
object
7 properties
Sender
object
11 properties
ScheduleUpdate
object
1 property
FlowCreate
object
3 properties 2 required
Step
object
6 properties
SenderCreate
object
8 properties 2 required
SequenceList
object
2 properties
SequenceCreate
object
4 properties 1 required
Pagination
object
4 properties
Sequence
object
8 properties
ManualStepDetails
object
2 properties
ContactCreate
object
5 properties 1 required
StepCreate
object
5 properties 4 required
ConfigUpdate
object
1 property
Contact
object
9 properties
SequenceUpdate
object
4 properties
Schedule
object
3 properties
FlowUpdate
object
2 properties
Config
object
3 properties
SenderList
object
3 properties
FlowList
object
2 properties
ContactList
object
2 properties
LinkedInStepDetails
object
3 properties
StepUpdate
object
5 properties
StepList
object
3 properties
EmailStepDetails
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

customeros-flows-api-openapi.yml Raw ↑

Other APIs CustomerOS publishes across the network.

CustomerOS Website Tracker
AE Profile APIs.io
CustomerOS GraphQL API
AE Profile APIs.io
CustomerOS Billing API
AE Profile APIs.io
CustomerOS CustomerBASE API
AE Profile APIs.io
CustomerOS Domains API
AE Profile APIs.io
CustomerOS Email Verification API
AE Profile APIs.io
CustomerOS Enrichment API
AE Profile APIs.io
CustomerOS IP Intelligence API
AE Profile APIs.io
CustomerOS Mailboxes API
AE Profile APIs.io
CustomerOS Outreach API
AE Profile APIs.io
#Flows
← Back to C APIs
API Details
ID
customeros:customeros-flows-api
Base URL
https://api.customeros.ai
Docs
https://github.com/customeros/customeros/tree/otter/packages/server/customer-os-api/docs
Provider
CustomerOS
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=customeros-flows-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/customeros-flows-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of CustomerOS Flows 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.