Zapier · Schema

ZapsResponse

A page of returned Zaps.

IntegrationsiPaaS

Properties

Name Type Description
next stringnull The URL to get the next set of records
previous stringnull The URL to get the previous set of records
count integer The total number of records matching the request
objects array The returned Zap data
View JSON Schema on GitHub

JSON Schema

partner-api-zaps-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ZapsResponse",
  "description": "A page of returned Zaps.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zapier/refs/heads/main/json-schema/partner-api-zaps-response-schema.json",
  "type": "object",
  "properties": {
    "next": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "readOnly": true,
      "description": "The URL to get the next set of records",
      "example": "https://example.com/path/abc123"
    },
    "previous": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "readOnly": true,
      "description": "The URL to get the previous set of records",
      "example": "https://example.com/path/abc123"
    },
    "count": {
      "type": "integer",
      "readOnly": true,
      "description": "The total number of records matching the request",
      "example": 100
    },
    "objects": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Zap"
      },
      "description": "The returned Zap data",
      "example": [
        {}
      ]
    }
  },
  "required": [
    "count",
    "next",
    "objects",
    "previous"
  ]
}