List DM automations
postkey_list_automationsPostkey: Lists the profile's DM automations (for example "comment GUIDE, get the link by DM") one page at a time (next_cursor; null: the last page): id, name, status (draft, live, paused, error), made_with (Quick form, Flow Builder, or Postkey (a built-in automation)), unpublished changes, and what starts each one with its keywords. Without search, newest edits first. With search, names AND keywords are matched, each result with match: "keyword" (a keyword is exactly the search), "name" (a whole word of its name) or "partial". When some automation has the search as a keyword, only those are listed unless include_partial is true. For a keyword ("the LIST automation"), act only on results with match "keyword": "name" and "partial" are other automations. match_note says which to act on. Use it to find an automation id; use postkey_get_automation for one automation's messages and settings, postkey_get_automation_stats for results, and postkey_list_automation_templates to make a new one.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many to return, 1 to 50. Default 20. | |
| cursor | No | The next_cursor of the previous answer, as it was. Leave out for the first page. | |
| search | No | A keyword or words of the name, at most 120 characters, case-insensitive: "GUIDE" finds the automation whose keyword is GUIDE (match "keyword"); when none has it, names with that word ("name") or containing it ("partial"). | |
| status | No | "all" (default). "draft": never switched on. "live": answering people. "paused": switched off. "error": has a problem to fix in Postkey. | |
| include_partial | No | With search: true also lists the "name" and "partial" matches when some automation has the search as a keyword. false (default): only the keyword matches then. Use true only when the person asks about names, not a keyword. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | false: refused (isError; code, message, guide_topic, url); no change. | |
| note | No | Present when more matched than were returned. | |
| total | No | Automations matching the filter. | |
| match_note | No | With search, when not every result is a keyword match or others were left out: which one to act on. | |
| automations | No | id, name, status, made_with (Quick form, Flow Builder, or Postkey (a built-in automation)), has_unpublished_changes, ever_published, problem, starts (starts_on, on, keywords, scope), updated_at; with search, match (keyword, name or partial). | |
| next_cursor | No | Pass as cursor for the next page; null on the last page. | |
| hidden_matches | No | With search and include_partial false: how many name or partial matches were left out because some automation has the search as a keyword. Missing when none was. |