List stored Actions

Community

Blog

Getting Started

How to

GET
Authentication
GET
Zapier account list
Stored Vs. Stateless Actions
Stored actions
- Stored actions introduction
- Configure stored actions in the AI Actions UI
- GET
  List stored Actions
- POST
  Run a stored action
- Manage stored actions
Stateless actions
Gathering action information

API Reference

system
auth
apps
actions
execution
ai-actions
utilities

Tools

Stateless action creator/runner

Libraries

TypeScript (Node.js, Deno)
React Components

Development Resources

Help

GET

api

ai-actions

Copy
curl --request GET \
  --url https://actions.zapier.com/api/v2/ai-actions/ \
  --header 'Authorization: Bearer <token>'

Copy
{
  "results": [
    {
      "id": "<string>",
      "description": "<string>",
      "account_id": 123,
      "authentication_id": 123,
      "app": "<string>",
      "action": "<string>",
      "action_type": "read",
      "params": {},
      "meta": {
        "params": {},
        "app_label": "<string>",
        "action_label": "<string>",
        "authentication_label": "<string>",
        "app_needs_auth": true
      },
      "needs": [
        {
          "key": "<string>",
          "type": "int",
          "label": "<string>",
          "required": true,
          "prefill": "<string>",
          "searchfill": "<string>",
          "capabilities": [
            "<string>"
          ],
          "custom_field": true,
          "depends_on": [
            "<string>"
          ],
          "input_format": [
            "<any>"
          ],
          "language": "<string>",
          "parent_key": "<string>",
          "regex": "<string>",
          "alters_custom_fields": true,
          "choices": [
            {
              "key": "<string>",
              "label": "<string>",
              "sample": "<string>"
            }
          ],
          "default": "<string>",
          "help_text": "<string>",
          "placeholder": "<string>",
          "format": "<string>",
          "list": true
        }
      ]
    }
  ],
  "configuration_link": "<string>"
}

These actions can then be provided as tools to an LLM, which can decide what parameters to use when running the action.

See Run a stored action for details on running an action.

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Response

200 - application/json

results

object[]

required

results.id

string

required

The unique ID of the AI action.

results.description

string

required

Description of the AI action.

results.account_id

integer | null

required

Zapier account ID that will be used when running the action.

results.authentication_id

integer | null

required

ID of the authentication to use for the app when running the action.

results.app

string | null

required

The app that the action is for.

results.action

string | null

required

The action that will be run.

results.action_type

enum<string> | null

required

The type of action that will be run.

Available options:

read,

write,

search,

read_bulk

results.params

object

required

The parameters that will be used when running the action.

results.meta

object

required

Metadata about the AI action.

results.needs

object[] | null

results.needs.key

string

required

The key of the need.

This is used as the key in objects such as params and params_constraints.

results.needs.type

enum<string> | null

required

The type of the need.

Available options:

int,

integer,

float,

decimal,

unicode,

text,

str,

string,

datetime,

boolean,

bool,

file,

copy,

password,

dict,

code,

filter,

confirmation

results.needs.label

string | null

required

Label for the need.

results.needs.required

boolean | null

required

Whether or not a value for this need is required in order to run the action.

results.needs.prefill

string | null

required

If a need has a prefill, then that means its value should come from a list of available values.

See Get prefill Choices for information on how to get the available values for a need.

results.needs.custom_field

boolean | null

required

If this is true, then it means that this need comes from a custom field.

See the Custom fields section in Get action details and needs for more information on these needs.

results.needs.depends_on

string[] | null

required

A list of the key of other needs that this need depends on.

If this exists, it means that the value of this need may change if one of the listed needs changes. See the Custom fields section in Get action details and needs for more information on these needs.

results.needs.choices

object[] | null

required

If this array exists, then it will be a static list of choices that the value of this need can be when it runs.

results.needs.help_text

string | null

required

Additional information that is specific to this need. May include links to outside documentation.

results.needs.searchfill

string | null

results.needs.capabilities

string[] | null

results.needs.input_format

any[] | null

results.needs.language

string | null

results.needs.parent_key

string | null

results.needs.regex

string | null

results.needs.alters_custom_fields

boolean | null

results.needs.default

string | null

results.needs.placeholder

string | null

results.needs.format

string | null

results.needs.list

boolean | null

configuration_link

string

required

URL to configure and expose more actions.

Was this page helpful?

Configure stored actions in the AI Actions UI Run a stored action

Copy
curl --request GET \
  --url https://actions.zapier.com/api/v2/ai-actions/ \
  --header 'Authorization: Bearer <token>'

Copy
{
  "results": [
    {
      "id": "<string>",
      "description": "<string>",
      "account_id": 123,
      "authentication_id": 123,
      "app": "<string>",
      "action": "<string>",
      "action_type": "read",
      "params": {},
      "meta": {
        "params": {},
        "app_label": "<string>",
        "action_label": "<string>",
        "authentication_label": "<string>",
        "app_needs_auth": true
      },
      "needs": [
        {
          "key": "<string>",
          "type": "int",
          "label": "<string>",
          "required": true,
          "prefill": "<string>",
          "searchfill": "<string>",
          "capabilities": [
            "<string>"
          ],
          "custom_field": true,
          "depends_on": [
            "<string>"
          ],
          "input_format": [
            "<any>"
          ],
          "language": "<string>",
          "parent_key": "<string>",
          "regex": "<string>",
          "alters_custom_fields": true,
          "choices": [
            {
              "key": "<string>",
              "label": "<string>",
              "sample": "<string>"
            }
          ],
          "default": "<string>",
          "help_text": "<string>",
          "placeholder": "<string>",
          "format": "<string>",
          "list": true
        }
      ]
    }
  ],
  "configuration_link": "<string>"
}