Skip to main content
POST
List
You can retrieve a list of an organization members’ current packages by calling the packages/list endpoint.

Request

Request

Body

Some filters are restricted based on the authentication method used or permissions of the organization member.To filter packages for other members, you must use one of the following authentication methods:
  • Organization API Key
  • User API Key with Sign Editor or Package Editor role enabled
  • Organization OAuth App
To filter packages for teams, the authenticated member must belong to the specified team.
string
The member ID to retrieve packages for.
string
The team ID to retrieve packages for.
string
Filter packages by folder ID.
boolean
When true, retrieves packages for all members in the organization.
Filter packages by search terms.
This performs a full text search on package name, description, message, category, client number, matter number, as well as signer and recipient first name, last name, email, and mobile number. You can use * as a wildcard character to perform suffix matching (e.g., Contract* matches any package whose name contains a word starting with “Contract”).
string[]
Filter packages by package type.
string[]
Filter packages by package state.
boolean
When true will only return executed packages, when false will only return non-executed packages. Leave null to not apply any executed filter.
number
Filter packages whose sign by date is within the next X days.
For example, setting days to 7 will return packages whose sign by date is within the next 7 days.
You can use a negative value to filter packages whose sign by date is in the past.
string
default:"created"
Sort results by one of the following:
number
default:50
Number of packages to return.
number
Number of packages to skip. Used for pagination or infinite scroll.

Response

object[]
Array of packages returned.
number
Total number of packages that match filter criteria.
number
Number of packages returned per request.
number
Number of packages skipped.