Skip to main content
GET
/
apps
/
{client_id}
/
workflows
/
{workflow_id}
curl -H "Authorization: Bearer sk_workspace_test_..." \
  "https://sandbox.api.hopae.com/connect/v1/apps/abc123/workflows/wf_abc123"

{
  "workflowId": "wf_abc123",
  "name": "KYC Premium",
  "entryNodeId": "nd_req",
  "nodes": [
    { "id": "nd_req", "type": "request", "next": "nd_verify" },
    { "id": "nd_verify", "type": "verification", "next": "nd_resp", "config": { "channel": "oidc", "claims": ["name", "birthdate"] } },
    { "id": "nd_resp", "type": "response" }
  ],
  "createdAt": "2025-01-15T10:00:00.000Z",
  "updatedAt": "2025-01-15T10:00:00.000Z"
}
Returns details of a specific workflow.

​
Request

​
Authorization
string
required
Bearer <API_KEY> from Console > Developers > Workspace API Keys.

​
Path parameters

​
client_id
string
required
Client identifier of the app.
​
workflow_id
string
required
Workflow identifier.

​
Response

​
workflowId
string
Workflow identifier.
​
name
string
Workflow name.
​
entryNodeId
string
Entry node ID.
​
nodes
object[]
Array of flow nodes.
​
createdAt
string
ISO 8601 timestamp.
​
updatedAt
string
ISO 8601 timestamp.
curl -H "Authorization: Bearer sk_workspace_test_..." \
  "https://sandbox.api.hopae.com/connect/v1/apps/abc123/workflows/wf_abc123"

{
  "workflowId": "wf_abc123",
  "name": "KYC Premium",
  "entryNodeId": "nd_req",
  "nodes": [
    { "id": "nd_req", "type": "request", "next": "nd_verify" },
    { "id": "nd_verify", "type": "verification", "next": "nd_resp", "config": { "channel": "oidc", "claims": ["name", "birthdate"] } },
    { "id": "nd_resp", "type": "response" }
  ],
  "createdAt": "2025-01-15T10:00:00.000Z",
  "updatedAt": "2025-01-15T10:00:00.000Z"
}