---
title: "Get multiple envelopes"
method: POST
path: "/envelope/get-many"
tags: ["Envelope"]
---

# Get multiple envelopes

`POST /envelope/get-many`

Retrieve multiple envelopes by their IDs

## Request body

- object
  - `ids` union, required
    - object
      - `type` 'envelopeId', required
      - `ids` string[], required
    - object
      - `type` 'documentId', required
      - `ids` number[], required
    - object
      - `type` 'templateId', required
      - `ids` number[], required

## 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
    - `documentMeta` object, required
      - `signingOrder` 'PARALLEL' | 'SEQUENTIAL', required
      - `distributionMethod` 'EMAIL' | 'NONE', required
      - `id` string, required
      - `subject` string, nullable, required
      - `message` string, nullable, required
      - `timezone` string, nullable, required
      - `dateFormat` string, nullable, required
      - `redirectUrl` string, nullable, required
      - `typedSignatureEnabled` boolean, required
      - `uploadSignatureEnabled` boolean, required
      - `drawSignatureEnabled` boolean, required
      - `allowDictateNextSigner` boolean, required
      - `language` string, required
      - `emailSettings` object, nullable, required
        - `recipientSigningRequest` boolean, required
        - `recipientRemoved` boolean, required
        - `recipientSigned` boolean, required
        - `documentPending` boolean, required
        - `documentCompleted` boolean, required
        - `documentDeleted` boolean, required
        - `ownerDocumentCompleted` boolean, required
        - `ownerRecipientExpired` boolean, required
        - `ownerDocumentCreated` boolean, required
      - `emailId` string, nullable, required
      - `emailReplyTo` string, nullable, required
      - `envelopeExpirationPeriod` union, required
        - object
          - `unit` 'day' | 'week' | 'month' | 'year', required
          - `amount` integer, required
        - object
          - `disabled` true, 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
    - `fields` object[], required
      - `envelopeId` string, required
      - `envelopeItemId` string, required
      - `type` 'SIGNATURE' | 'FREE_SIGNATURE' | 'INITIALS' | 'NAME' | 'EMAIL' | 'DATE' | 'TEXT' | 'NUMBER' | 'RADIO' | 'CHECKBOX' | 'DROPDOWN', required
      - `id` number, required
      - `secondaryId` string, required
      - `recipientId` number, required
      - `page` number, required
      - `positionX` unknown, required
      - `positionY` unknown, required
      - `width` unknown, required
      - `height` unknown, required
      - `customText` string, required
      - `inserted` boolean, required
      - `fieldMeta` union, required
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop', required
          - `type` 'signature', required
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop'
          - `type` 'initials', required
          - `textAlign` 'left' | 'center' | 'right'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop'
          - `type` 'name', required
          - `textAlign` 'left' | 'center' | 'right'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop', required
          - `type` 'email', required
          - `textAlign` 'left' | 'center' | 'right'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop', required
          - `type` 'date', required
          - `textAlign` 'left' | 'center' | 'right'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop'
          - `type` 'text', required
          - `text` string
          - `characterLimit` number
          - `textAlign` 'left' | 'center' | 'right'
          - `lineHeight` number, nullable
          - `letterSpacing` number, nullable
          - `verticalAlign` 'top' | 'middle' | 'bottom' | 'null', nullable
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop'
          - `type` 'number', required
          - `numberFormat` string, nullable
          - `value` string
          - `minValue` number, nullable
          - `maxValue` number, nullable
          - `textAlign` 'left' | 'center' | 'right'
          - `lineHeight` number, nullable
          - `letterSpacing` number, nullable
          - `verticalAlign` 'top' | 'middle' | 'bottom' | 'null', nullable
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop'
          - `type` 'radio', required
          - `values` object[]
            - `id` number, required
            - `checked` boolean, required
            - `value` string, required
          - `direction` 'vertical' | 'horizontal', required
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop'
          - `type` 'checkbox', required
          - `values` object[]
            - `id` number, required
            - `checked` boolean, required
            - `value` string, required
          - `validationRule` string
          - `validationLength` number
          - `direction` 'vertical' | 'horizontal', required
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop'
          - `type` 'dropdown', required
          - `values` object[]
            - `value` string, required
          - `defaultValue` string
    - `envelopeItems` object[], required
      - `envelopeId` string, required
      - `documentDataId` string, required
      - `id` string, required
      - `title` string, required
      - `order` number, required
    - `directLink` object, nullable, required
      - `directTemplateRecipientId` number, required
      - `enabled` boolean, required
      - `id` string, required
      - `token` string, required
    - `team` object, required
      - `id` number, required
      - `url` string, required
    - `user` object, required
      - `id` number, required
      - `name` string, required
      - `email` string, required

## Other responses

- `400` — Invalid input data
- `401` — Authorization not provided
- `403` — Insufficient access
- `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)