Developers
API referenceReferenceWorkflows

Workflow - Scheduled trigger preview

Preview the next scheduled trigger occurrences for a candidate config.

POST
/v1/business/{business_slug}/workflows/scheduled_trigger_preview/

Path Parameters

business_slug*string

Business slug that scopes this request. If you do not have one yet, call common_accessible_businesses_list and pick a slug from the response.

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/business/string/workflows/scheduled_trigger_preview/" \  -H "Content-Type: application/json" \  -d '{    "frequency": "string",    "hour": 0  }'
{  "frequency": "string",  "hour": 0,  "minute": 0,  "day_of_week": 1,  "day_of_month": 1}

Workflow run - Cancel POST

Request cancellation of a pending or running workflow run.

Contacts - List GET

List contacts for the selected business. Supports search and filters such as invoicing-enabled, exact name, and excluded contact ID. Use `contact_business_id` for deterministic lookup when the identifier is known.