# CustomerOS Flows API

**Canonical:** https://apis.io/apis/customeros/customeros-flows-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 Flows API is one of 11 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 Flows. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

## Operations (34)

| Method | Path | Summary |
|---|---|---|
| GET | `/flows` | List all flows |
| POST | `/flows` | Create a new flow |
| GET | `/flows/{flow_id}` | Get details of a specific flow |
| PATCH | `/flows/{flow_id}` | Update details of a specific flow |
| DELETE | `/flows/{flow_id}` | Delete a specific flow |
| GET | `/flows/{flow_id}/enable` | Enable a flow |
| GET | `/flows/{flow_id}/disable` | Disable a flow |
| GET | `/flows/{flow_id}/stats` | Get stats for a flow |
| GET | `/flows/{flow_id}/sequences` | List all sequences |
| POST | `/flows/{flow_id}/sequences` | Create new sequence |
| GET | `/flows/{flow_id}/sequences/{sequence_id}` | Get details of a specific sequence |
| PATCH | `/flows/{flow_id}/sequences/{sequence_id}` | Update details of a specific sequence |
| DELETE | `/flows/{flow_id}/sequences/{sequence_id}` | Delete a sequence |
| POST | `/flows/{flow_id}/sequences/{sequence_id}/enable` | Enable a sequence |
| POST | `/flows/{flow_id}/sequences/{sequence_id}/disable` | Disable a sequence |
| GET | `/flows/{flow_id}/sequences/{sequence_id}/stats` | Get statistics for a specific sequence |
| GET | `/flows/{flow_id}/schedule` | Get details of a specific sequence schedule |
| PUT | `/flows/{flow_id}/schedule` | Update details of a specific sequence schedule |
| DELETE | `/flows/{flow_id}/schedule` | Delete details of a specific sequence schedule |
| GET | `/flows/{flow_id}/config` | Get details of a specific sequence configuration |
| PUT | `/flows/{flow_id}/config` | Update details of a specific sequence configuration |
| DELETE | `/flows/{flow_id}/config` | Delete details of a specific sequence configuration |
| GET | `/flows/{flow_id}/sequences/{sequence_id}/steps` | List all steps for a sequence |
| POST | `/flows/{flow_id}/sequences/{sequence_id}/steps` | Add a step to a sequence |
| GET | `/flows/{flow_id}/sequences/{sequence_id}/steps/{step_id}` | List details for a step in a sequence |
| PUT | `/flows/{flow_id}/sequences/{sequence_id}/steps/{step_id}` | Update a step in a sequence |
| DELETE | `/flows/{flow_id}/sequences/{sequence_id}/steps/{step_id}` | Delete a step in a sequence |
| GET | `/flows/{flow_id}/senders` | List all senders for a sequence |
| POST | `/flows/{flow_id}/senders` | Add a sender to a sequence |
| DELETE | `/flows/{flow_id}/senders/{sender_id}` | Remove sender from a sequence |
| GET | `/flows/{flow_id}/sequences/{sequence_id}/contacts` | List all contacts for a sequence |
| POST | `/flows/{flow_id}/sequences/{sequence_id}/contacts` | Add contacts to a sequence |
| GET | `/flows/{flow_id}/sequences/{sequence_id}/contacts/{contact_id}` | Get details of a specific contact in a sequence |
| DELETE | `/flows/{flow_id}/sequences/{sequence_id}/contacts/{contact_id}` | Remove a contact from a sequence |

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/customeros/refs/heads/main/openapi/customeros-flows-api-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

## Other CustomerOS APIs (10)

- [CustomerOS Website Tracker](https://apis.io/apis/customeros/customeros-website-tracker/)
- [CustomerOS GraphQL API](https://apis.io/apis/customeros/customeros-graphql-api/)
- [CustomerOS Billing API](https://apis.io/apis/customeros/customeros-billing-api-api/)
- [CustomerOS CustomerBASE API](https://apis.io/apis/customeros/customeros-customerbase-api-api/)
- [CustomerOS Domains API](https://apis.io/apis/customeros/customeros-domains-api/)
- [CustomerOS Email Verification API](https://apis.io/apis/customeros/customeros-email-verification-api/)
- [CustomerOS Enrichment API](https://apis.io/apis/customeros/customeros-enrichment-api-api/)
- [CustomerOS IP Intelligence API](https://apis.io/apis/customeros/customeros-ip-intelligence-api/)
- [CustomerOS Mailboxes API](https://apis.io/apis/customeros/customeros-mailboxes-api/)
- [CustomerOS Outreach API](https://apis.io/apis/customeros/customeros-outreach-api/)

## Tags

Flows

---

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