Zapier · Schema
_ListOutputFieldsRequest
The common data object that includes inputs and an authentication id.
IntegrationsiPaaS
Properties
| Name | Type | Description |
|---|---|---|
| authentication | stringnull | An Authentication ID, as provided by the `/authentications` endpoint. |
| inputs | object | 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. |
| fetch_live_samples | boolean | 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 |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "_ListOutputFieldsRequest",
"description": "The common data object that includes inputs and an authentication id.",
"$id": "https://raw.githubusercontent.com/api-evangelist/zapier/refs/heads/main/json-schema/partner-api--list-output-fields-request-schema.json",
"type": "object",
"properties": {
"authentication": {
"type": [
"string",
"null"
],
"description": "An Authentication ID, as provided by the `/authentications` endpoint.",
"example": "example-value"
},
"inputs": {
"type": "object",
"additionalProperties": {},
"description": "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.",
"example": {}
},
"fetch_live_samples": {
"type": "boolean",
"default": false,
"description": "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.",
"example": false
}
},
"required": [
"authentication",
"inputs"
]
}