POST
/
api
/
v2
/
apps
/
{app}
/
actions
/
{action}
/

Authorizations

Authorization
string
headerrequired

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
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
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
results
object[]
required
List Authentications For AppGet Prefill Choices