Workflow Developer API

Get Developer Workflow

Read an active, historical, or draft workflow definition by identifier.

GET/developer/v1/workflows/{definition_id}

Authorizations

Authorization

stringheaderrequired

Send your GenHealth credential as Bearer <YOUR_API_KEY>. This endpoint requires workflow:read for the authenticated organization.

Headers

Accept

stringheader

Response media type. Use application/json for the current API.

Parameters

definition_idrequired

stringpath

version_id

string | nullquery

draft

booleanquery

Default: false

Responses

200Successful Response

WorkflowDefinitionResponse

idstring

org_idstring

namestring

descriptionstring | null

statusstring

nodesarray<WorkflowNodeSchema>

edgesarray<WorkflowEdgeSchema>

triggerobject<string, any> | null

422Validation Error

HTTPValidationError

detailarray<ValidationError>

Request example

curl --request GET \
  --url 'https://api.umpa.genhealth.ai/developer/v1/workflows/{definition_id}?draft=false' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Accept: application/json'

Response example

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "string",
  "description": "string",
  "status": "open",
  "nodes": [],
  "edges": [],
  "trigger": {
    "example_key": "string"
  }
}

View OpenAPI document