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

Nash Workflow API

Workflow automation management

Nash Workflow API is one of 30 APIs that Nash publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Workflow. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, an AsyncAPI specification, and rate-limit docs.

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

Requests are made against 4 base URLs: https://api.sandbox.usenash.com, https://api.sandbox.ap-southeast-2.usenash.com, https://api.usenash.com, https://api.ap-southeast-2.usenash.com.

7 operations 5 paths 14 schemas 3 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.usenash.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Nash Workflow API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT, API Key) (Token).

Paths & Operations 7

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

Workflow 7

Workflow automation management

GET
/v1/workflows
List Workflows
list_workflows_v1_workflows_get → 422
POST
/v1/workflows
Create Workflow
create_workflow_v1_workflows_post body → 422
GET
/v1/workflows/schema
Get Workflow Schema
get_workflow_schema_v1_workflows_schema_get → 200422
GET
/v1/workflows/{id}
Get Workflow
get_workflow_v1_workflows__string_id__get 1 param → 422
PATCH
/v1/workflows/{id}
Update Workflow
update_workflow_v1_workflows__string_id__patch 1 param body → 422
POST
/v1/workflows/{id}/status
Set Workflow Status
set_workflow_status_v1_workflows__string_id__status_post 1 param body → 422
POST
/v1/workflows/{id}/trigger
Trigger Workflow
trigger_workflow_v1_workflows__string_id__trigger_post 1 param body → 422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are WorkflowNodeInputSerializer (8 properties), UpdateWorkflowInputSerializer (6 properties), CreateWorkflowInputSerializer (6 properties), WorkflowEdgeInputSerializer (5 properties). Each schema is shown below with its type and property counts.

CreateWorkflowInputSerializer
object
6 properties 4 required
WorkflowTriggerType
string
Types of workflow triggers.
NashErrorDetails
object
3 properties 2 required
UpdateWorkflowInputSerializer
object
6 properties
WorkflowTriggerInputSerializer
object
5 properties 1 required
SetWorkflowStatusSerializer
object
1 property 1 required
WorkflowEdgeType
string
WorkflowNodeInputSerializer
object
8 properties 2 required
WorkflowEdgeInputSerializer
object
5 properties 4 required
NashValidationError
object
3 properties 3 required
WorkflowNodeType
string
Types of workflow nodes.
TriggerWorkflowSerializer
object
4 properties
WorkflowNodeAction
string
Actions that can be performed by a workflow node.
WorkflowStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nash-workflow-api-openapi.yml Raw ↑

Other APIs Nash publishes across the network.

Nash AI Functions API
Nash Annotate API
Nash Batch Job API
Nash Contracts API
Nash Couriers API
Nash Delivery Windows API
Nash Dispatch Strategies API
Nash Feedback API
Nash Fleet API
Nash Job API
Nash Messaging API
Nash Miscellaneous API