Sign in
Automations

List automations

Your automations with performance and outreach metrics. Includes creators reached, sample requests, videos posted, and GMV. reply_rate is populated for Running, Stopped, and Completed automations.

post/automations/list

Request body

pageinteger
page_sizeinteger
sort_by'gmv' | 'created_at' | 'completed_at' | 'creators_reached' | 'dm_response_count' nullable
sort_dir'asc' | 'desc'
start_datestring date nullable

Inclusive window start (YYYY-MM-DD). Scopes ACTIVITY, not creation: when supplied (alone or with end_date) the row set is restricted to automations that sent outreach in the window (an initial DM or a Target Collab invite dated inside it), so a long-running automation created earlier still appears with its in-window throughput. creators_reached / skipped / total_creators likewise switch from LIFETIME materialized-view values to in-window DISTINCT counts against the raw event tables. created_at is used only for sorting.

end_datestring date nullable

Inclusive window end (YYYY-MM-DD). When supplied (alone or with start_date), see start_date for the activity-window and creator-metric semantics.

automation_typestring nullable

Filter by the raw Automation.automation_type value, matched EXACTLY (case-sensitive). These values are historical/unnormalized — known examples: Target Collab, TC Cleanup, New Sample Request Processing. Unknown values (including the lowercase target_collab / tc_cleanup forms) match nothing. Email also returns nothing — email automations live in a separate table with no list read path yet; see the excluded block and POST /automations/email.

statusstring nullable

Filter by status. Accepts either the display status (Completed | Stopped | Running | …) or the raw internal status (continue | failed | inactive | …) that /automations/stats reports. Evergreen CRM-group automations display as Completed between cycles — read the is_evergreen field on each row to tell 'armed and waiting' from 'finished'.

show_archivedboolean

Include archived automations (state=archived). Default false mirrors the portal; the excluded block reports how many archived rows are hidden while this is false.

created_viastring[] nullable

Include only automations created by these surfaces. Common values: portal | api | api_direct | mcp | agent | slack | internal | campaign_tc_auto (set is not closed). NULL/empty provenance matches portal. Values not present in the shop's automation data match nothing; future/internal values remain filterable when they appear in the data. Example: ["api_direct"] returns only single-creator direct invites.

exclude_created_viastring[] nullable

Exclude automations created by these surfaces. Applied after created_via. Example: ["api_direct"] hides the API direct invite — {handle} rows produced by POST /public/v1/target-collabs so the list shows only your managed automations.

Response

Successful Response

currencystring required
{"stackTrail":"components:schemas:AutomationsListPaginatedResponse:properties:pagination","oasType":"schema","type":"unknown","title":"Pagination"}
shops_queriedstring[] nullable

Shop names included when querying multiple shops (x-shop-id: all or comma-separated).

excludedobject nullable

Present only when this endpoint hides automations that exist for the shop, so 'none shown' can be told apart from 'none exist'. pagination.total_count counts only rows THIS endpoint returns (live, non-email). Keys: archived (count hidden unless show_archived=true); email (count of email automations — a separate table managed via POST /automations/email, no list read path yet); and a note.

Changes

No recorded changes to this endpoint across all 1 revision of this API.