---
title: "Find envelopes"
method: GET
path: "/envelope"
tags: ["Envelope"]
---

# Find envelopes

`GET /envelope`

Find envelopes based on search criteria

## Query parameters

- `query` string
- `page` number
- `perPage` number
- `type` 'DOCUMENT' | 'TEMPLATE'
- `templateId` number
- `source` 'DOCUMENT' | 'TEMPLATE' | 'TEMPLATE_DIRECT_LINK'
- `status` 'DRAFT' | 'PENDING' | 'COMPLETED' | 'REJECTED' | 'CANCELLED'
- `hasExpiredRecipients` 'true' | 'false'
- `folderId` string
- `orderByColumn` 'createdAt'
- `orderByDirection` 'asc' | 'desc'

## Response `200`

Successful response

- object
  - `data` object[], required
    - `internalVersion` number, required
    - `type` 'DOCUMENT' | 'TEMPLATE', required
    - `status` 'DRAFT' | 'PENDING' | 'COMPLETED' | 'REJECTED' | 'CANCELLED', required
    - `source` 'DOCUMENT' | 'TEMPLATE' | 'TEMPLATE_DIRECT_LINK', required
    - `visibility` 'EVERYONE' | 'MANAGER_AND_ABOVE' | 'ADMIN', required
    - `templateType` 'PUBLIC' | 'PRIVATE' | 'ORGANISATION', required
    - `id` string, required
    - `secondaryId` string, required
    - `externalId` string, nullable, required
    - `createdAt` string, required
    - `updatedAt` string, required
    - `completedAt` string, nullable, required
    - `deletedAt` string, nullable, required
    - `title` string, required
    - `authOptions` object, nullable, required
      - `globalAccessAuth` string[], required
      - `globalActionAuth` string[], required
    - `formValues` object, nullable, required
    - `publicTitle` string, required
    - `publicDescription` string, required
    - `userId` number, required
    - `teamId` number, required
    - `folderId` string, nullable, required
    - `templateId` number, nullable, required
    - `user` object, required
      - `id` number, required
      - `name` string, required
      - `email` string, required
    - `recipients` object[], required
      - `envelopeId` string, required
      - `role` 'CC' | 'SIGNER' | 'VIEWER' | 'APPROVER' | 'ASSISTANT', required
      - `readStatus` 'NOT_OPENED' | 'OPENED', required
      - `signingStatus` 'NOT_SIGNED' | 'SIGNED' | 'REJECTED', required
      - `sendStatus` 'NOT_SENT' | 'SENT', required
      - `id` number, required
      - `email` string, required
      - `name` string, required
      - `token` string, required
      - `documentDeletedAt` string, nullable, required
      - `expired` string, nullable, required
      - `expiresAt` string, nullable, required
      - `expirationNotifiedAt` string, nullable, required
      - `signedAt` string, nullable, required
      - `authOptions` object, nullable, required
        - `accessAuth` string[], required
        - `actionAuth` string[], required
      - `signingOrder` number, nullable, required
      - `rejectionReason` string, nullable, required
    - `team` object, nullable, required
      - `id` number, required
      - `url` string, required
  - `count` number, required
  - `currentPage` number, required
  - `perPage` number, required
  - `totalPages` number, required

## Other responses

- `400` — Invalid input data
- `401` — Authorization not provided
- `403` — Insufficient access
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.net/documenso/apis/documenso-v2-api.md) · [All operations](https://skmtc.net/documenso/apis/documenso-v2-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/documenso/documenso-v2-api/revisions/3db245102197/schema)