Skip to main content
GET
/
api
/
v1
/
flows
/
{id}
Get a flow
curl --request GET \
  --url https://api.dualship.run/api/v1/flows/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Workspace-Id: <x-workspace-id>'
{
  "created_at": "2024-01-15T10:30:00Z",
  "description": "Handles user registration and welcome email",
  "edges": [
    123
  ],
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "metadata": [
    123
  ],
  "name": "User Registration Flow",
  "nodes": [
    123
  ],
  "project_id": "550e8400-e29b-41d4-a716-446655440001",
  "slug": "user-registration",
  "status": "active",
  "trigger_config": [
    123
  ],
  "trigger_type_id": "550e8400-e29b-41d4-a716-446655440002",
  "updated_at": "2024-01-15T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication

Headers

​
X-Workspace-Id
string
required

Workspace ID

Path Parameters

​
id
string
required

Flow ID

Response

Flow details

​
created_at
string
Example:

"2024-01-15T10:30:00Z"

​
description
string
Example:

"Handles user registration and welcome email"

​
edges
integer[]
​
id
string
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
metadata
integer[]
​
name
string
Example:

"User Registration Flow"

​
nodes
integer[]
​
project_id
string
Example:

"550e8400-e29b-41d4-a716-446655440001"

​
slug
string
Example:

"user-registration"

​
status
string
Example:

"active"

​
trigger_config
integer[]
​
trigger_type_id
string
Example:

"550e8400-e29b-41d4-a716-446655440002"

​
updated_at
string
Example:

"2024-01-15T10:30:00Z"