Form List Response

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/getsmileapi/json-schema/getsmileapi-form-list-response-schema.json",
  "title": "Form List Response",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/getsmileapi-forms-alpha-api-openapi.yml#/components/schemas/FormListResponse",
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/$defs/ObjectMetadataRefCode"
    },
    "message": {
      "$ref": "#/$defs/ObjectMetadataRefMessage"
    },
    "requestId": {
      "$ref": "#/$defs/ObjectMetadataRefRequestID"
    },
    "data": {
      "$ref": "#/$defs/FormListData"
    }
  },
  "$defs": {
    "Form": {
      "title": "Form",
      "type": "object",
      "x-internal": false,
      "description": "The stored form information of the user from an wink site.",
      "x-tags": [
        "Forms"
      ],
      "properties": {
        "id": {
          "$ref": "#/$defs/RefObjectID"
        },
        "createdAt": {
          "$ref": "#/$defs/RefDateTime"
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the form.",
          "maxLength": 255
        },
        "userId": {
          "type": "string",
          "description": "The ID of the user who submitted the form."
        },
        "winkSiteId": {
          "type": "string",
          "description": "The ID of the wink site where the form was submitted."
        },
        "winkSiteSessionId": {
          "type": "string",
          "description": "The ID of the wink site session where the form was submitted."
        },
        "reference": {
          "type": "string",
          "description": "The reference of the form."
        },
        "data": {
          "type": "object",
          "description": "The data submitted by the user.",
          "additionalProperties": {
            "type": "object"
          }
        }
      },
      "required": [
        "id",
        "createdAt",
        "winkSiteId",
        "winkSiteSessionId",
        "userId",
        "reference",
        "data"
      ]
    },
    "FormListData": {
      "type": "object",
      "properties": {
        "nextCursor": {
          "$ref": "#/$defs/ObjectNextCursor"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Form"
          }
        }
      }
    },
    "ObjectMetadataRefCode": {
      "type": "string",
      "title": "ObjectMetadataRefCode",
      "description": "Request status code",
      "enum": [
        "OK",
        "CREATED",
        "INVALID_CREDENTIALS",
        "INVALID_PARAMETERS",
        "INVALID_TOKEN",
        "UNAUTHORIZED_ACCESS",
        "MISSING_RESOURCE",
        "REQUEST_LIMIT_EXCEEDED",
        "SERVER_ERROR",
        "UNSUPPORTED_METHOD",
        "SERVER_UNAVAILABLE",
        "TIME_LIMIT_EXCEEDED"
      ],
      "x-internal": false
    },
    "ObjectMetadataRefMessage": {
      "type": "string",
      "title": "ObjectMetadataRefMessage",
      "description": "Message response to the request",
      "x-internal": false
    },
    "ObjectMetadataRefRequestID": {
      "type": "string",
      "title": "ObjectMetadataRefRequestID",
      "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.",
      "x-internal": false
    },
    "ObjectNextCursor": {
      "title": "ObjectNextCursor",
      "type": "string",
      "description": "The next cursor value that can be used in the following query.",
      "x-internal": false
    },
    "RefDateTime": {
      "type": "string",
      "title": "Date and Time string",
      "format": "date-time",
      "description": "Date and time"
    },
    "RefObjectID": {
      "type": "string",
      "title": "Object ID",
      "description": "Unique ID of this object"
    }
  }
}