Get public form list

get https://api.dottedsign.com/v1/public_forms/list

Get public form list.

scope: public_forms.general.read
available user plans: pro, business, and enterprise

Response

Response body

object

data

object

total_count

integer

Total count of items.

current_page

integer

Current page number.

total_pages

integer

Total page count.

templates

array of objects

templates

object

form_id

integer

Form ID.

uuid

string

Form UUID.

form_name

string

Form name.

description

string | null

Form description.

status

string

Form status.

publish unpublish terminated

template_name

string

Form template name.

share_link

string

Form public link.
It shows when status is publish.

signer_infos

array of objects

signer_infos

object

signer_type

string

Specifies the type of signer in the form stage:

form_signer: an unspecified user who only needs to provide basic information like name or email when signing
normal_signer: a designated user

The first signer in the sequence must be a form_signer, and all normal_signers must follow after all form_signers.

form_signer normal_signer

name

string

Form stage signer name. Required if signer_type is normal_signer.

string

length ≤ 250

Form stage signer email. Required if signer_type is normal_signer.

phone

string

Form stage signer phone (area code + number). Required if signer_type is normal_signer, and the used template requires SMS OTP.

requisite

object

Public form signer info - requisite.

role

string

Form stage signer role.

search_keys

array of strings

Form completed task's search keys.

search_keys

sent_num

integer

The number of sent tasks in the form.

finish_num

integer

The number of finished tasks in the form.

goal_num

integer | null

The number of task required to complete the form. If -1, then the form is not limited by the number of tasks.

reach_limit

boolean

Form reaches goal_num or end_at .

created_at

integer

Form creation timestamp.

end_at

integer | null

Form ended up timestamp.

Headers

object

Content-Type

string

Content-Length

integer

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.dottedsign.com/v1/public_forms/list?page=1&per_page=10' \
3
     --header 'accept: application/json'


xxxxxxxxxx
174
}
1
{
2
  "data": {
3
    "total_count": 5,
4
    "current_page": 1,
5
    "total_pages": 1,
6
    "forms": [
7
      {
8
        "form_id": 13,
9
        "uuid": "76479690-770d-4320-9f9b-a59ea4e5d0d5",
10
        "form_name": "Test Form 11",
11
        "description": "This is test form 11",
12
        "signer_infos": [
13
          {
14
            "signer_type": "form_signer",
15
            "requisite": {
16
              "name": "required",
17
              "email": "optional"
18
            }
19
          },
20
          {
21
            "signer_type": "form_signer",
22
            "requisite": {
23
              "name": "required",
24
              "email": "optional"
25
            }

200200