Welcome
Workflow API
Workflow Element
Embed Enhancements
Getting Started With the API
Categories
Accounts
Zap Templates
Authentications
Experimental
Schemas
- Common Types
Categories
Accounts
Zap Templates
Authentications
Experimental
Get Output Fields
Get the Output Fields for a particular Action, using the provided authentication and inputs.
OAuth
This endpoint requires the zap:write
OAuth scope.
curl --request POST \
--url https://api.zapier.com/v2/actions/{action_id}/outputs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"authentication": "example_QVaAreV1",
"inputs": {
"someparam": "somevalue"
}
}
}'
{
"data": [
[
{
"id": "commit__message",
"sample": "Git 2.0",
"title": "Commit Message",
"type": "output_field"
}
],
[
{
"id": "parents[]sha",
"sample": "4a28f169ad29ba452e0e7bea2583914c10c58322",
"title": "Parents Sha",
"type": "output_field"
}
],
[
{
"id": "parents[]url",
"sample": "https://github.com/git/git/commit/4a28f169ad29ba452e0e7bea2583914c10c58322",
"title": "Parents Url",
"type": "output_field"
}
]
],
"meta": {
"count": 3,
"limit": null,
"offset": null
},
"links": {
"next": null,
"prev": null
}
}
Authorizations
See our OAuth2 authentication documentation
Path Parameters
An Action ID, as provided by the /actions
endpoint.
Body
The common data object that includes inputs and an authentication id.
An Authentication ID, as provided by the /authentications
endpoint.
The current set of input fields in a JSON object, where each key is the id
of an Input Field, and the corresponding value the current value of the field.
Whether to retrieve live samples for the field. While this can be helpful in supporting the identification of an output, note that this has latency implications as it may require an additional request to 3rd party services. This is not supported for WRITE
actions, please use step testing instead.
Used for paginating results. Specifies the maximum number of items to return per page.
x > 1
Used for paginating results. Specifies the offset to use. Defaults to 0
x > 0
Response
Base Response definition to be used in other Response Serializers.
Be sure to include the data
field after using this class
The meta object returned in paginated response bodies.
curl --request POST \
--url https://api.zapier.com/v2/actions/{action_id}/outputs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"authentication": "example_QVaAreV1",
"inputs": {
"someparam": "somevalue"
}
}
}'
{
"data": [
[
{
"id": "commit__message",
"sample": "Git 2.0",
"title": "Commit Message",
"type": "output_field"
}
],
[
{
"id": "parents[]sha",
"sample": "4a28f169ad29ba452e0e7bea2583914c10c58322",
"title": "Parents Sha",
"type": "output_field"
}
],
[
{
"id": "parents[]url",
"sample": "https://github.com/git/git/commit/4a28f169ad29ba452e0e7bea2583914c10c58322",
"title": "Parents Url",
"type": "output_field"
}
]
],
"meta": {
"count": 3,
"limit": null,
"offset": null
},
"links": {
"next": null,
"prev": null
}
}