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

BetterCloud Workflows API

Manage automation workflows and triggers

BetterCloud Workflows API is one of 5 APIs that BetterCloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 5 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api.bettercloud.com/v1.

5 operations 3 paths 8 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.bettercloud.com/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

BetterCloud Workflows API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — API key authentication. Provide your BetterCloud API key in the X-API-Key header. Keys can be generated from the BetterCloud developer portal.

Paths & Operations 5

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

Workflows 5

Manage automation workflows and triggers

GET
/workflows
BetterCloud List Workflows
listWorkflows 2 params → 200
POST
/workflows
BetterCloud Create Workflow
createWorkflow body → 201
GET
/workflows/{id}
BetterCloud Get Workflow
getWorkflow 1 param → 200404
DELETE
/workflows/{id}
BetterCloud Delete Workflow
deleteWorkflow 1 param → 204404
POST
/workflows/{id}/run
BetterCloud Run Workflow
runWorkflow 1 param body → 202

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Workflow (8 properties), WorkflowCreateRequest (4 properties), ErrorResponse (4 properties), MetaResponse (3 properties). Each schema is shown below with its type and property counts.

WorkflowResponse
object
Single workflow response.
1 property
WorkflowCreateRequest
object
Request body for creating a workflow.
4 properties 1 required
WorkflowRunRequest
object
Request body for triggering a workflow execution.
1 property 1 required
ErrorResponse
object
Standard error response from BetterCloud API.
4 properties 4 required
WorkflowListResponse
object
Paginated list of workflows.
2 properties
Workflow
object
An automation workflow that can be triggered to execute actions across SaaS applications.
8 properties
WorkflowRunResponse
object
Response from triggering a workflow execution.
1 property
MetaResponse
object
Pagination metadata for list responses.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bettercloud-workflows-api-openapi.yml Raw ↑

Other APIs BetterCloud publishes across the network.

BetterCloud Events API
BetterCloud Groups API
BetterCloud Integrations API
BetterCloud Users API
Where this information came from

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