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

Hopae, Inc. Workspace API - Workflows API

Workflow configuration per app

Hopae, Inc. Workspace API - Workflows API is one of 9 APIs that Hopae, Inc. publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workspace API - Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://sandbox.api.hopae.com/connect.

7 operations 4 paths 4 schemas 1 DELETE3 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://sandbox.api.hopae.com/connect
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 5

Hopae, Inc. Workspace API - Workflows API declares 5 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (API Key) (workspaceApiKey). It accepts HTTP bearer tokens (JWT) (consoleJwt). It accepts HTTP bearer tokens (JWT) (workspace-api-key). It accepts HTTP basic authentication (app-basic).

  • basicAuth — Basic authentication using clientId and clientSecret. For direct API calls, format the Authorization header as Authorization: Basic . In the Mintlify playgroun…
  • workspaceApiKey — Workspace API key authentication. Pass your workspace API key as Authorization: Bearer skworkspace....
  • consoleJwt — Console JWT authentication. Issued by Clerk after Console login.

Paths & Operations 7

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

Workspace API - Workflows 7

Workflow configuration per app

GET
/v1/apps/{id}/workflows/node-types
List available node types
WorkspaceWorkflowController_getNodeTypes → 200
POST
/v1/apps/{id}/workflows
Create a workflow
WorkspaceWorkflowController_createWorkflow 1 param body → 201400404409
GET
/v1/apps/{id}/workflows
List all workflows
WorkspaceWorkflowController_listWorkflows 1 param → 200404
GET
/v1/apps/{id}/workflows/{workflowId}
Get a workflow
WorkspaceWorkflowController_getWorkflow 2 params → 200404
PATCH
/v1/apps/{id}/workflows/{workflowId}
Update a workflow
WorkspaceWorkflowController_updateWorkflow 2 params body → 200400404
DELETE
/v1/apps/{id}/workflows/{workflowId}
Delete a workflow
WorkspaceWorkflowController_deleteWorkflow 2 params → 200400404
POST
/v1/apps/{id}/workflows/{workflowId}/set-default
Set a workflow as default
WorkspaceWorkflowController_setDefault 2 params → 200404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are WorkflowResponseDto (6 properties), FlowNodeDto (4 properties), UpdateWorkflowDto (3 properties), CreateWorkflowDto (3 properties). Each schema is shown below with its type and property counts.

CreateWorkflowDto
object
3 properties 3 required
FlowNodeDto
object
4 properties 2 required
WorkflowResponseDto
object
6 properties 4 required
UpdateWorkflowDto
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hopae-inc-workspace-api-workflows-api-openapi.yml Raw ↑

Other APIs Hopae, Inc. publishes across the network.

Hopae, Inc. Console - API Keys API
Hopae, Inc. Providers API
Hopae, Inc. Token API
Hopae, Inc. Verifications API
Hopae, Inc. Workspace API - Activation API
Hopae, Inc. Workspace API - Apps API
Hopae, Inc. Workspace API - Production Tests API
Hopae, Inc. Workspace API - Workspace API