Zapier · JSON Structure

Partner Api List Output Fields Request Structure

The common data object that includes inputs and an authentication id.

Type: object Properties: 3 Required: 2
IntegrationsiPaaS

_ListOutputFieldsRequest is a JSON Structure definition published by Zapier, describing 3 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

authentication inputs fetch_live_samples

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zapier/refs/heads/main/json-structure/partner-api--list-output-fields-request-structure.json",
  "name": "_ListOutputFieldsRequest",
  "description": "The common data object that includes inputs and an authentication id.",
  "type": "object",
  "properties": {
    "authentication": {
      "type": "string",
      "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"
  ]
}