Get client workflow counts by group and state

GET

client

workflows

counts

Get client workflow counts by group and state

curl --request GET \
  --url http://localhost:8080/api/v1/client/workflows/counts \
  --header 'Authorization: <api-key>'

{
  "data": {
    "by_group": [
      {
        "enrolled_count": 123,
        "group_label": "<string>",
        "total_active_count": 123
      }
    ],
    "by_state": [
      {
        "enrolled_count": 123,
        "state": 123,
        "state_label": "<string>",
        "total_active_count": 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

Query Parameters

string

Search by workflow name or description

state

integer

Filter by workflow state (1=acquisition,2=engagement,3=revenue,4=health)

Response

data

object

Show child attributes

errors

object[]

Show child attributes

message

string

Example:

"Operation successful"

meta

object

success

boolean

Example:

true

Get client workflow detailRetrieve workflow detail for the authenticated client, including send config, customization overrides, and default template preview.

⌘I

Get client workflow counts by group and state

curl --request GET \
  --url http://localhost:8080/api/v1/client/workflows/counts \
  --header 'Authorization: <api-key>'

{
  "data": {
    "by_group": [
      {
        "enrolled_count": 123,
        "group_label": "<string>",
        "total_active_count": 123
      }
    ],
    "by_state": [
      {
        "enrolled_count": 123,
        "state": 123,
        "state_label": "<string>",
        "total_active_count": 123
      }
    ]
  },
  "errors": [
    {
      "condition": "format",
      "error": "Invalid email format",
      "key": "email"
    }
  ],
  "message": "Operation successful",
  "meta": {},
  "success": true
}