PublicFormList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/dottedsign-com/json-schema/dottedsign-com-public-form-list-schema.json",
  "title": "PublicFormList",
  "description": "Public form list.",
  "x-generated": "2026-11-06",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/dottedsign-com-publicforms-api-openapi.yml#/components/schemas/PublicFormList",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "total_count": {
          "type": "integer",
          "description": "Total count of items."
        },
        "current_page": {
          "type": "integer",
          "description": "Current page number."
        },
        "total_pages": {
          "type": "integer",
          "description": "Total page count."
        },
        "templates": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PublicForm"
          }
        }
      }
    }
  },
  "$defs": {
    "PublicForm": {
      "type": "object",
      "description": "Public form.",
      "properties": {
        "form_id": {
          "type": "integer",
          "description": "Form ID."
        },
        "uuid": {
          "type": "string",
          "description": "Form UUID."
        },
        "form_name": {
          "type": "string",
          "description": "Form name."
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "Form description."
        },
        "status": {
          "type": "string",
          "description": "Form status.",
          "enum": [
            "publish",
            "unpublish",
            "terminated"
          ]
        },
        "template_name": {
          "type": "string",
          "description": "Form template name."
        },
        "share_link": {
          "type": "string",
          "description": "Form public link.\n*It shows when status is `publish`.*\n"
        },
        "signer_infos": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PublicFormSignerInfoFull"
          }
        },
        "search_keys": {
          "type": "array",
          "description": "Form completed task's search keys.",
          "items": {
            "type": "string"
          }
        },
        "sent_num": {
          "type": "integer",
          "description": "The number of sent tasks in the form."
        },
        "finish_num": {
          "type": "integer",
          "description": "The number of finished tasks in the form."
        },
        "goal_num": {
          "type": [
            "integer",
            "null"
          ],
          "description": "The number of task required to complete the form. If `-1`, then the form is not limited by the number of tasks."
        },
        "reach_limit": {
          "type": "boolean",
          "description": "Form reaches goal_num or end_at ."
        },
        "created_at": {
          "type": "integer",
          "description": "Form creation timestamp."
        },
        "end_at": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Form ended up timestamp."
        }
      }
    },
    "PublicFormSignerInfoFull": {
      "type": "object",
      "properties": {
        "signer_type": {
          "type": "string",
          "description": "Specifies the type of signer in the form stage:\n- `form_signer`: an unspecified user who only needs to provide basic information like name or email when signing\n- `normal_signer`: a designated user\n\nThe first signer in the sequence must be a `form_signer`, and all `normal_signer`s must follow after all `form_signer`s.\n",
          "enum": [
            "form_signer",
            "normal_signer"
          ]
        },
        "name": {
          "type": "string",
          "description": "Form stage signer name. *Required if `signer_type` is `normal_signer`.*"
        },
        "email": {
          "type": "string",
          "description": "Form stage signer email. *Required if `signer_type` is `normal_signer`.*",
          "maxLength": 250
        },
        "phone": {
          "type": "string",
          "description": "Form stage signer phone (area code + number). *Required if `signer_type` is `normal_signer`, and the used template requires SMS OTP.*"
        },
        "requisite": {
          "$ref": "#/$defs/PublicFormSignerInfoRequisite"
        },
        "role": {
          "type": "string",
          "description": "Form stage signer role."
        }
      },
      "description": "Public form signer info (full version)"
    },
    "PublicFormSignerInfoRequisite": {
      "type": "object",
      "description": "Public form signer info - requisite.",
      "properties": {
        "name": {
          "type": "string",
          "description": "Signer should provide his name or not.",
          "enum": [
            "required",
            "optional"
          ]
        },
        "email": {
          "type": "string",
          "description": "Signer should provide his email or not.",
          "enum": [
            "required"
          ]
        }
      }
    }
  }
}