Kit · Schema

List snippets Response

Email MarketingCreator EconomySubscribersAutomationNewslettersSequencesFormsBroadcasts

Properties

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

JSON Schema

list_snippets_response.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/convertkit/main/json-schema/list_snippets_response.json",
  "title": "List snippets Response",
  "x-tag": "Snippets",
  "type": "object",
  "properties": {
    "snippets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "snippet_type": {
            "type": "string"
          },
          "archived": {
            "type": "boolean"
          },
          "key": {
            "type": "string"
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          },
          "content": {
            "type": "string"
          },
          "document": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "value": {
                "nullable": true
              },
              "value_html": {
                "type": "string"
              },
              "value_plain": {
                "nullable": true
              },
              "version": {
                "type": "integer"
              }
            },
            "required": [
              "id",
              "value",
              "value_html",
              "value_plain",
              "version"
            ]
          }
        },
        "required": [
          "id",
          "name",
          "snippet_type",
          "archived",
          "key",
          "created_at",
          "updated_at",
          "content",
          "document"
        ]
      }
    },
    "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": [
    "snippets",
    "pagination"
  ]
}