Skip to main content
GET
List eSignature documents

Authorizations

x-token
string
header
required

Query Parameters

userId
string

The acting user. Required with an API key or partner token; a delegate token is its own user.

view
enum<string>
Available options:
all,
send,
inProgress,
countersign,
complete,
expired,
archived,
recycleBin,
createdByMe,
sharedWithMe,
expiringSoon
status
enum<string>

completed means signed by every recipient and waiting for countersignature.

Available options:
send,
in-progress,
completed,
countersigned
folderId
string
searchTerm
string

Comma-separated terms matched against document names.

assignee
string
boardUuid
string

Only documents created from cards on this board.

senderId
string

Only documents created by this user.

start
string<date-time>

Created on or after; needs end.

end
string<date-time>

Created on or before; needs start.

sortBy
enum<string>

createdAt and updatedAt sort newest first, other fields ascending; lastSigned orders each page by its latest signature.

Available options:
createdAt,
updatedAt,
name,
expirationDate,
lastSigned
page
integer
default:0
Required range: x >= 0
pageSize
integer
default:50
Required range: 1 <= x <= 100

Response

A page of documents.

data
object[]
totalCount
integer
page
integer
pageSize
integer
totalPages
integer