Skip to main content
GET
List packages

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-workspace-id
string

The workspace the key was issued for, as returned by GET /api/v1/workspaces. Optional: omitting it acts in the key's workspace, and any other id is rejected with 401.

Query Parameters

status

Only packages in this status. DRAFT is not yet sent; SCHEDULED is queued to send at its scheduled time; IN_PROGRESS is out for signing; COMPLETED is signed by every signer; DECLINED is refused by a recipient; ON_HOLD is paused by the sender; VOID is ended early by the sender or at its expiry. VIEWED is not a stored status: it selects packages, whatever their status, that a recipient has opened.

Available options:
DRAFT,
SCHEDULED,
IN_PROGRESS,
COMPLETED,
DECLINED,
ON_HOLD,
VOID
Example:

"IN_PROGRESS"

Only packages whose title contains this text, ignoring case.

Minimum string length: 1
Example:

"Employment"

page
integer
default:1

The page to return, counting from 1.

Required range: x >= 1
Example:

1

pageSize
integer
default:25

Packages per page, from 1 to 100.

Required range: 1 <= x <= 100
Example:

25

Response

Success

data
object
required