Skip to main content
GET
/
client
/
workflows
/
{workflow_id}
Get client workflow detail
curl --request GET \
  --url http://localhost:8080/api/v1/client/workflows/{workflow_id} \
  --header 'Authorization: <api-key>'
{
  "data": {
    "category_text": "<string>",
    "custom_template": {
      "id": 123,
      "name": "<string>",
      "subject": "<string>"
    },
    "customization_overrides": {
      "delay_minutes": 123,
      "preferred_send_hour": 123,
      "preferred_send_minute": 123,
      "priority_score": 123,
      "template_id": 123
    },
    "default_priority_score": 123,
    "default_send_config": {
      "bypass_send_window": true,
      "delay_minutes": 123,
      "preferred_send_hour": 123,
      "preferred_send_minute": 123,
      "send_time_mode_text": "<string>"
    },
    "default_template": {
      "id": 123,
      "name": "<string>",
      "subject": "<string>"
    },
    "default_template_preview": {
      "html_body": "<string>",
      "id": 123,
      "name": "<string>",
      "subject": "<string>",
      "text_body": "<string>"
    },
    "description": "<string>",
    "effective_priority_score": 123,
    "effective_send_config": {
      "bypass_send_window": true,
      "delay_minutes": 123,
      "preferred_send_hour": 123,
      "preferred_send_minute": 123,
      "send_time_mode_text": "<string>"
    },
    "enrollment": {
      "can_enroll": true,
      "disabled_at": "<string>",
      "enrolled_at": "<string>",
      "is_enrolled": true
    },
    "id": 123,
    "is_active": true,
    "name": "<string>",
    "state_text": "<string>",
    "trigger_tags": [
      {
        "state_text": "<string>",
        "tag_id": 123,
        "tag_name": "<string>",
        "tag_state": 123
      }
    ]
  },
  "errors": [
    {
      "condition": "format",
      "error": "Invalid email format",
      "key": "email"
    }
  ],
  "message": "Operation successful",
  "meta": {},
  "success": true
}

Authorizations

Authorization
string
header
required

JWT Bearer token or raw API key via Authorization header

Path Parameters

workflow_id
integer
required

Workflow ID

Response

OK

data
object
errors
object[]
message
string
Example:

"Operation successful"

meta
object
success
boolean
Example:

true