Get group task list

get https://api.dottedsign.com/v1/groups/sign_tasks/list

Get group task list.

scope: groups.sign_tasks.read
available user plans: business and enterprise

Query Params

page

integer

≥ 1

Defaults to 1

Page number.

per_page

integer

1 to 20

Defaults to 10

Number of items per page.

has_order

boolean

Signers should sign sequentially or not.

field_key

string

Field key. Required if field_value is provided.

field_value

string

Field value. Required if field_key is provided.

metadata_key

string

Metadata key. Required if metadata_value is provided.

metadata_value

string

Metadata value. Required if metadata_key is provided.

file_name

string

Task name.

signer

string

Signer's email or name.

status

string

Defaults to waiting

Task status.

emails

array of strings

Emails of group members.

emails

template_id

integer

Template ID.

start_from

integer

Last updated timestamp that query start from. Should use with end_at.

end_at

integer

Last updated timestamp that query end at. Should use with start_from.

sort_type

string

Defaults to updated_at

Sort type.

order_by

string

Defaults to desc

Order by.

Headers

Authorization

string

required

OAuth2 Bearer token.

Responses

Response body

object

data

object

total_count

integer

Total count of items.

current_page

integer

Current page number.

total_pages

integer

Total page count.

tasks

array of objects

tasks

object

task_id

integer

Task ID.

file_name

string

File name.

sign_type

string

Sign type.

sign_and_send create_and_invite kiosk guest_signing form

has_order

boolean

Signers should sign sequentially or not.

status

string

Task status.

draft waiting completed declined expired voided deleted

last_modified_by_owner

boolean

Last modification by owner or not.

owned_by_me

boolean

Task is owned by me or not.

access_info

object

Sign task access info.

current_stage_infos

array of objects

Current stages' info.

current_stage_infos

object

stage_id

integer

Stage ID.

string

Signer's email.

name

string

Signer's name.

details

array

Stage details, including owner's and stages' information.

For all tasks, first schema is SignTaskOwner.
For type of sign_and_send, guest_signing or kiosk tasks, see DummyStage schema.
For type of create_and_invite or form tasks, see SignStage schema.

details

task_setting

object

Sign task setting.

metadata

object

Metadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.

Has additional fields

created_at

integer

Task creation timestamp.

last_modified_at

integer

Task last modification timestamp.

Headers

object

Content-Type

string

Content-Length

integer

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.dottedsign.com/v1/groups/sign_tasks/list?page=1&per_page=10&status=waiting&sort_type=updated_at&order_by=desc' \
3
     --header 'accept: application/json'


xxxxxxxxxx
183
}
1
{
2
  "data": {
3
    "total_count": 2,
4
    "current_page": 1,
5
    "total_pages": 1,
6
    "tasks": [
7
      {
8
        "task_id": 2,
9
        "file_name": "my_draft.pdf",
10
        "sign_type": "create_and_invite",
11
        "has_order": true,
12
        "status": "waiting",
13
        "last_modified_at": 1742185072,
14
        "last_modified_by_owner": false,
15
        "owned_by_me": false,
16
        "access_info": {
17
          "view": true,
18
          "sign": true,
19
          "edit": false,
20
          "review": false,
21
          "decline": true,
22
          "confirm": false,
23
          "update": false,
24
          "forward": true,
25
          "forward_request": false,

200200

403403

404404