API Reference

Get task list

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

Get task list.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

Page number.

integer
1 to 20
Defaults to 10

Number of items per page.

string
enum
Defaults to desc

Order by.

Allowed:
string
enum
Defaults to updated_at

Sort type.

Allowed:
boolean

Signers should sign sequentially or not.

string

Field key. Required if field_value is provided.

string

Field value. Required if field_key is provided.

string

Task name.

metadata_key[]
array of strings
length ≤ 10

Metadata key. Use with metadata_value to filter by key-value pairs using AND semantics. Up to 10 pairs allowed. Required if metadata_value is provided.

metadata_key[]
metadata_value[]
array of strings
length ≤ 10

Metadata value. Must have the same number of elements as metadata_key. Required if metadata_key is provided.

metadata_value[]
string

Signer's email or name.

string
enum
Defaults to waiting

Task status.

Allowed:
integer

Template ID.

integer

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

integer

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

Headers
string
required

OAuth2 Bearer token.

Responses

Updated about 1 month ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago