Retrieve all notification settings

GET /v5/notifications/settings

Retrieve all notification settings

cURL

curl --request GET \
  --url https://api.kadoa.com/v5/notifications/settings \
  --header 'x-api-key: <api-key>'

200

{
  "data": {
    "settings": [
      {
        "id": "<string>",
        "workflowId": "<string>",
        "eventType": "<string>",
        "eventConfiguration": {},
        "enabled": true,
        "channels": [
          {
            "id": "<string>",
            "name": "<string>",
            "channelType": "<string>"
          }
        ],
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    ]
  },
  "status": "<string>",
  "message": "<string>"
}

Authorizations

x-api-key · string · header · required

API key for authentication

Query Parameters

workflowId · string

Workflow ID(s) - can be single ID, comma-separated IDs, or 'null' for workspace-level settings

eventType · enum<string>

Event type filter (optional)

Available options: workflow_started, workflow_finished, workflow_failed, workflow_sample_finished, workflow_data_change, system_maintenance, service_degradation, credits_low, free_trial_ending

Response

200

application/json

Settings retrieved successfully

data · object

Show child attributes

status · string

message · string