# List Bundles

**GET** `/bundles/`

Returns a paginated list of Bundles in your Account, ordered by created date (from most recent to
least recent). Pagination can be controlled via Pagination paramaters (see Overview->Pagination).
Querystring filters paramaters can be combined, e.g.
`/bundles/?search=Gibbons&status__in=se,co&tag=needs-attention`. When combining filters, only Bundles
matching ALL the filters are returned.

## Request

### Parameters

- `search` (query, string): A search query. Only bundles matching the search will be returned. The following data in the
the Bundle is searched:

- bundle slug
- bundle label
- bundle custom_key
- signer name
- signer email
- signer phones

E.g. `/bundles/?search=foobar@example.com`

- `status` (query, string): Limit bundles to those with the specified status.

* ne: New - the Bundle was newly created
* dr: Draft - the Bundle has not yet been sent
* pr: Provisioning - the Bundle is being cloned or processed in the background
* pe: Pending - the Bundle is queued to be launched while documents are processing
* se: Sent - the Bundle has been sent, but not yet started by any Signers
* st: Started - at least one Signer has started reviewing the document(s)
* co: Complete - all Signers have completed reviewing / signing
* ca: Cancelled - the Bundle was cancelled
* ex: Expired - the Bundle expired before it was Complete
* fa: Failed - an error occurred and the Bundle could not be created or completed
* de: Declined - at least one Signer declined to sign

E.g. `/bundles/?status=co`

- `status__in` (query, string): Limit bundles to those with one of the specified statuses. Statuses should be comma separated.
E.g. `/bundles/?status=co,se,st`

- `tag` (query, string): Return Bundles that have the given tag. E.g. `/bundles/?tag=some-tag`
- `tag__in` (query, string): Return Bundles that have at least one of the given tags. Tags should be comma separated.
E.g. `/bundles/?tag=some-tag,another-tag`

- `ordering` (query, string): Control the sort order of Bundles. Prefix with "-" to reverse the sort order.
By default Bundles are sorted by "-created", ie the Bundle creation date from most
to least recent.

- `created` (query, string): Retrieve Bundles created within a specified date range
Note: Dates are expressed as YYYY-MM-DD format.

E.g. `/bundles/?created_after=2024-10-01&created_before=2024-10-08`

- `sent` (query, string): E.g. `/bundles/?sent_after=2024-10-01&sent_before=2024-10-08`

- `completed` (query, string): E.g. `/bundles/?completed_after=2024-10-01&completed_before=2024-10-08`

- `template` (query, string): Filter bundles by template ID. Only bundles created from the specified template will be returned.

E.g. `/bundles/?template=a053644f-e371-4883-ac17-534445993346`

### Responses

- `200`: A paged array of Bundles
  - Content types: `application/json`