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

One of the workspaces the key was issued for, as returned by GET /api/v1/workspaces. Required on a key that acts for members. On any other key it is optional and omitting it acts in the key's default workspace. Any id outside the key's workspaces is rejected with 401.

x-act-as
string

Required on a key that acts for members, refused on any other key. Names the member the call runs as, as key=value: email=jane@acme.com, employee_id=E-1001, scim_external_id=… or a custom identifier. Keys are lowercase and matched case-insensitively. The call fails with 403 when no active member of the workspace matches.

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:
PREPARING,
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