Skip to main content
POST
/
api
/
v2
/
apps
/
{app}
/
actions
/
{action}
Get Action Details
curl --request POST \
  --url https://actions.zapier.com/api/v2/apps/{app}/actions/{action}/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "params": {}
}'
{
  "results": [
    {
      "action_has_custom_needs_probability": 123,
      "action": {
        "type": "<string>",
        "key": "<string>",
        "name": "<string>",
        "noun": "<string>",
        "description": "<string>",
        "is_important": true,
        "is_hidden": true,
        "needs": [
          {
            "key": "<string>",
            "type": "int",
            "label": "<string>",
            "required": true,
            "prefill": "<string>",
            "searchfill": "<string>",
            "capabilities": [
              "<string>"
            ],
            "custom_field": true,
            "depends_on": [
              "<string>"
            ],
            "from_search": true,
            "from_write": true,
            "input_format": [
              "<unknown>"
            ],
            "language": "<string>",
            "parent_key": "<string>",
            "send_in_json": true,
            "regex": "<string>",
            "alters_custom_fields": true,
            "choices": [
              {
                "key": "<string>",
                "label": "<string>",
                "sample": "<string>"
              }
            ],
            "default": "<string>",
            "help_text": "<string>",
            "placeholder": "<string>",
            "default_guessable": true,
            "list": true,
            "format": "<string>"
          }
        ],
        "meta": {
          "hook": {
            "directions": "<string>",
            "is_notification": true,
            "is_pollable": true,
            "is_polling_notification": true,
            "is_subscription": true,
            "url": "<string>"
          }
        },
        "popularity": 123,
        "app_name": "<string>"
      },
      "action_gives": [
        {
          "key": "<string>",
          "score": 123,
          "subscore": 123,
          "type": "<string>",
          "label": "<string>",
          "zap_meta_sample": "<unknown>",
          "custom_field": false,
          "important": false
        }
      ],
      "action_needs": [
        {
          "key": "<string>",
          "type": "int",
          "label": "<string>",
          "required": true,
          "prefill": "<string>",
          "searchfill": "<string>",
          "capabilities": [
            "<string>"
          ],
          "custom_field": true,
          "depends_on": [
            "<string>"
          ],
          "from_search": true,
          "from_write": true,
          "input_format": [
            "<unknown>"
          ],
          "language": "<string>",
          "parent_key": "<string>",
          "send_in_json": true,
          "regex": "<string>",
          "alters_custom_fields": true,
          "choices": [
            {
              "key": "<string>",
              "label": "<string>",
              "sample": "<string>"
            }
          ],
          "default": "<string>",
          "help_text": "<string>",
          "placeholder": "<string>",
          "default_guessable": true,
          "list": true,
          "format": "<string>"
        }
      ],
      "action_sample": {}
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
app
string
required

The app that the action belongs to.

​
action
string
required

The action to get details for.

Query Parameters

​
action_type
enum<string>
default:write

The type of the action to get details for.

This can be:

  • write: Actions that have side effects (such as sending an email or updating a spreadsheet)
  • search: Actions that return results (such as searching for a contact or getting a list of emails)
Available options:
read,
write,
search,
read_bulk
​
account_id
integer

The Zapier account ID to use.

Account IDs available to the user can be listed using the Get Account List endpoint

​
authentication_id
integer | null

ID of the authentication to use for the app.

Authentications available to the user can be listed using the List Authentications For App endpoint.

​
action_extra
enum<string>[]

What kind of information to return with the action details.

List of:

  • action_needs: Include the needs of the action. These are what are provided when running the action.
  • action_gives: Include the gives of the action. These are what the action returns when it runs.
  • action_sample: Include a sample of the action. Note: This will dramatically slow down the response from this endpoint. Only use it if you really need the sample.
Available options:
action_needs,
action_gives,
action_sample

Body

application/json
​
params
Params · object
required

A dictionary of key-value pairs, where the key is a need key and the value is a selected value for that need.

Response

200 - application/json

OK

​
results
ActionDetailsResultSchema · object[]
required