curl --request POST \
--url https://api.zapier.com/v2/actions/{action_id}/inputs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"authentication": "928117",
"inputs": {
"spreadsheet": "my_sheet"
}
}
}
'{
"links": {
"next": null,
"prev": null
},
"meta": {
"count": 2,
"limit": null,
"offset": 0
},
"data": [
{
"type": "input_field",
"id": "input",
"default_value": "",
"depends_on": [],
"choice_depends_on": [],
"description": "Use the Input Data fields above to assign key names (left) and map values (right) from previous steps. Use notation `inputData.keyName` or `inputData['keyName']` to access the values within your code. The data will be provided **as strings**. Learn more [here](https://zapier.com/help/create/code-webhooks/use-javascript-code-in-zaps#input-data-for-code-steps).",
"invalidates_input_fields": false,
"is_required": false,
"placeholder": "",
"title": "Input Data",
"value_type": "OBJECT"
},
{
"type": "input_field",
"id": "code",
"default_value": "// this is wrapped in an `async` function\n// you can use await throughout the function\n\noutput = [{id: 123, hello: \"world\"}];",
"depends_on": [],
"choice_depends_on": [],
"description": "**Warning! This is an advanced action!** Uses Node 10.x.x. Please read the [Code documentation for more information](/help/create/code-webhooks/use-javascript-code-in-zaps).",
"format": "CODE",
"invalidates_input_fields": false,
"is_required": true,
"placeholder": "",
"title": "Code",
"value_type": "STRING"
}
]
}{
"errors": [
{
"status": 400,
"code": "parse_error",
"title": "ParseError",
"detail": "Malformed request.",
"source": null,
"meta": {
"source": "ZAPIER",
"full_details": {
"message": "Malformed request.",
"code": "parse_error"
}
}
}
]
}{
"errors": [
{
"status": 123,
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"status": 123,
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"status": 123,
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"status": 123,
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"status": 500,
"code": "error",
"title": "APIException",
"detail": "A server error occurred.",
"source": null,
"meta": {
"source": "ZAPIER",
"full_details": {
"message": "A server error occurred.",
"code": "error"
}
}
}
]
}{
"errors": [
{
"status": 123,
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"status": 123,
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}Actions
Get Input Fields
Get the Input Fields for a particular Action, using the provided authentication and inputs. See the fields and fieldsets guide for more information.
By default the Input Fields are resolved against the App’s current version. Pass a versioned selected_api (e.g. SplitwiseCLIAPI@1.0.0) to pin them to a specific version instead, which is useful when editing an Action that was created against an earlier version of the App.
See our docs for more information.
When using OAuth
This endpoint requires the zap:write OAuth scope.
POST
/
v2
/
actions
/
{action_id}
/
inputs
curl --request POST \
--url https://api.zapier.com/v2/actions/{action_id}/inputs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"authentication": "928117",
"inputs": {
"spreadsheet": "my_sheet"
}
}
}
'{
"links": {
"next": null,
"prev": null
},
"meta": {
"count": 2,
"limit": null,
"offset": 0
},
"data": [
{
"type": "input_field",
"id": "input",
"default_value": "",
"depends_on": [],
"choice_depends_on": [],
"description": "Use the Input Data fields above to assign key names (left) and map values (right) from previous steps. Use notation `inputData.keyName` or `inputData['keyName']` to access the values within your code. The data will be provided **as strings**. Learn more [here](https://zapier.com/help/create/code-webhooks/use-javascript-code-in-zaps#input-data-for-code-steps).",
"invalidates_input_fields": false,
"is_required": false,
"placeholder": "",
"title": "Input Data",
"value_type": "OBJECT"
},
{
"type": "input_field",
"id": "code",
"default_value": "// this is wrapped in an `async` function\n// you can use await throughout the function\n\noutput = [{id: 123, hello: \"world\"}];",
"depends_on": [],
"choice_depends_on": [],
"description": "**Warning! This is an advanced action!** Uses Node 10.x.x. Please read the [Code documentation for more information](/help/create/code-webhooks/use-javascript-code-in-zaps).",
"format": "CODE",
"invalidates_input_fields": false,
"is_required": true,
"placeholder": "",
"title": "Code",
"value_type": "STRING"
}
]
}{
"errors": [
{
"status": 400,
"code": "parse_error",
"title": "ParseError",
"detail": "Malformed request.",
"source": null,
"meta": {
"source": "ZAPIER",
"full_details": {
"message": "Malformed request.",
"code": "parse_error"
}
}
}
]
}{
"errors": [
{
"status": 123,
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"status": 123,
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"status": 123,
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"status": 123,
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"status": 500,
"code": "error",
"title": "APIException",
"detail": "A server error occurred.",
"source": null,
"meta": {
"source": "ZAPIER",
"full_details": {
"message": "A server error occurred.",
"code": "error"
}
}
}
]
}{
"errors": [
{
"status": 123,
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"status": 123,
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}Authorizations
See our OAuth2 authentication documentation here: https://docs.zapier.com/powered-by-zapier/api-reference/authentication
Path Parameters
An Action ID, as provided by the /actions endpoint.
Body
application/json
Common inputs with inputs and an authentication id.
The common data object that includes inputs and an authentication id.
Show child attributes
Show child attributes
Response
A successful response for getting the input fields for a particular Action.
The links object returned in paginated response bodies.
Show child attributes
Show child attributes
The meta object returned in paginated response bodies.
Show child attributes
Show child attributes
The base concept of a Fieldset, from which others extend
Represents Input Field data as accepted by the API
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Last modified on November 7, 2025
Was this page helpful?