Kit · Schema

List subscribers for a form Response

Email MarketingCreator EconomySubscribersAutomationNewslettersSequencesFormsBroadcasts

Properties

Name Type Description
subscribers array
pagination object
View JSON Schema on GitHub

JSON Schema

list_subscribers_for_a_form_response.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/convertkit/main/json-schema/list_subscribers_for_a_form_response.json",
  "title": "List subscribers for a form Response",
  "x-tag": "Forms",
  "type": "object",
  "properties": {
    "subscribers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "first_name": {
            "type": "string",
            "nullable": true
          },
          "email_address": {
            "type": "string"
          },
          "state": {
            "type": "string",
            "enum": [
              "active",
              "cancelled",
              "bounced",
              "complained",
              "inactive"
            ]
          },
          "created_at": {
            "type": "string"
          },
          "added_at": {
            "type": "string"
          },
          "fields": {
            "type": "object",
            "properties": {
              "category": {
                "type": "string",
                "nullable": true
              }
            },
            "required": [
              "category"
            ]
          },
          "referrer": {
            "type": "string"
          },
          "referrer_utm_parameters": {
            "type": "object",
            "properties": {
              "source": {
                "type": "string"
              },
              "medium": {
                "type": "string"
              },
              "campaign": {
                "type": "string"
              },
              "term": {
                "type": "string"
              },
              "content": {
                "type": "string"
              }
            },
            "required": [
              "source",
              "medium",
              "campaign",
              "term",
              "content"
            ]
          }
        },
        "required": [
          "id",
          "first_name",
          "email_address",
          "state",
          "created_at",
          "added_at",
          "referrer",
          "referrer_utm_parameters",
          "fields"
        ]
      }
    },
    "pagination": {
      "type": "object",
      "properties": {
        "has_previous_page": {
          "type": "boolean"
        },
        "has_next_page": {
          "type": "boolean"
        },
        "start_cursor": {
          "type": "string"
        },
        "end_cursor": {
          "type": "string"
        },
        "per_page": {
          "type": "integer"
        }
      },
      "required": [
        "has_previous_page",
        "has_next_page",
        "start_cursor",
        "end_cursor",
        "per_page"
      ]
    }
  },
  "required": [
    "subscribers",
    "pagination"
  ]
}