---
title: "Preview a trigger's audience"
method: POST
path: "/workflows/preview"
tags: ["Workflows"]
---

# Preview a trigger's audience

`POST /workflows/preview`

## Request

- Base URL: `https://api.reacherapp.com/public/v1`
- URL: `https://api.reacherapp.com/public/v1/workflows/preview`
- Auth: API key in header `x-api-key` and API key in header `x-shop-id`

How many creators match this trigger right now, after the settings' exclusions, with a sample of up to 50 named back. `unsupported` lists any rule that could not be answered for this shop — those rules match nobody rather than everybody, so a surprising zero is usually there.

## Request body

- WorkflowPreviewBody
  - `trigger` object, required: Just the trigger node — `type` (creator_matches or recurring) and its `config`. The rest of a definition does not affect who matches.
  - `settings` object, nullable: Only `exclusions` changes the answer here; the rest is ignored.
  - `limit` integer: How many matching creators to name back.

## Response `200`

Successful Response

- EnvelopeWorkflowPreviewPublic
  - `data` WorkflowPreviewPublic, required
    - `count` integer, required: Creators matching the trigger now, after exclusions.
    - `sample` WorkflowPreviewCreatorPublic[], required
      - `creator_id` string, required
      - `creator_name` string, nullable
    - `unsupported` string[]: Rules that could not be answered for this shop. They match nobody rather than everybody, so a surprising zero is usually here.

## Other responses

- `422`: Validation Error

## Changes

> 76 revisions in range; 1 not diffed.

- **2026-10-20** `9353ed4982e8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/reacherapp/apis/reacher-data-api/changes/workflows/preview/post.md)

---

[API](https://skmtc.dev/reacherapp/apis/reacher-data-api.md) - [All operations](https://skmtc.dev/reacherapp/apis/reacher-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/reacherapp/apis/reacher-data-api/revisions/63ce74b30b5a?raw)