> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getaptly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List eSignature documents

> Lists the eSignature documents the acting user can see, newest first:
public ones plus private ones shared with them or one of their teams.
Archived and deleted documents appear only in the `archived` and
`recycleBin` views (deleted ones for 30 days). An API key limited to
some boards only lists documents created from cards on those boards.




## OpenAPI

````yaml /openapi.yaml get /api/esignature/documents
openapi: 3.0.3
info:
  title: Aptly API
  version: '1.1'
  description: |
    The Aptly API lets external systems work with boards, contacts, inboxes,
    tasks, files, and other Aptly resources.

    Most endpoints accept an API key in the `x-token` header. Some endpoints
    also accept a delegate token or partner bearer token, as shown in each
    operation's security requirements, and explicitly public endpoints require
    no credential. API keys are scoped to a company and may be restricted to
    specific boards and read, insert, or update permissions; requests outside
    those restrictions receive a 403 `FORBIDDEN` response.
servers:
  - url: https://core-api.getaptly.com
    description: Production
security:
  - ApiKeyHeader: []
paths:
  /api/esignature/documents:
    get:
      tags:
        - eSignature
      summary: List eSignature documents
      description: |
        Lists the eSignature documents the acting user can see, newest first:
        public ones plus private ones shared with them or one of their teams.
        Archived and deleted documents appear only in the `archived` and
        `recycleBin` views (deleted ones for 30 days). An API key limited to
        some boards only lists documents created from cards on those boards.
      operationId: listEsignatureDocuments
      parameters:
        - name: userId
          in: query
          schema:
            type: string
          description: >-
            The acting user. Required with an API key or partner token; a
            delegate token is its own user.
        - name: view
          in: query
          schema:
            type: string
            enum:
              - all
              - send
              - inProgress
              - countersign
              - complete
              - expired
              - archived
              - recycleBin
              - createdByMe
              - sharedWithMe
              - expiringSoon
        - name: status
          in: query
          schema:
            type: string
            enum:
              - send
              - in-progress
              - completed
              - countersigned
          description: >-
            `completed` means signed by every recipient and waiting for
            countersignature.
        - name: folderId
          in: query
          schema:
            type: string
        - name: searchTerm
          in: query
          schema:
            type: string
          description: Comma-separated terms matched against document names.
        - name: assignee
          in: query
          schema:
            type: string
        - name: boardUuid
          in: query
          schema:
            type: string
          description: Only documents created from cards on this board.
        - name: senderId
          in: query
          schema:
            type: string
          description: Only documents created by this user.
        - name: start
          in: query
          schema:
            type: string
            format: date-time
          description: Created on or after; needs `end`.
        - name: end
          in: query
          schema:
            type: string
            format: date-time
          description: Created on or before; needs `start`.
        - name: sortBy
          in: query
          schema:
            type: string
            enum:
              - createdAt
              - updatedAt
              - name
              - expirationDate
              - lastSigned
          description: >-
            `createdAt` and `updatedAt` sort newest first, other fields
            ascending; `lastSigned` orders each page by its latest signature.
        - name: page
          in: query
          schema:
            type: integer
            default: 0
            minimum: 0
        - name: pageSize
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
      responses:
        '200':
          description: A page of documents.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
                      properties:
                        _id:
                          type: string
                        name:
                          type: string
                        status:
                          type: string
                        counterSigned:
                          type: boolean
                        expirationDate:
                          type: string
                          format: date-time
                        recipients:
                          type: array
                          items:
                            type: object
                            additionalProperties: true
                        linkedCards:
                          type: array
                          items:
                            type: object
                            additionalProperties: true
                        lastSignedAt:
                          type: string
                          format: date-time
                  totalCount:
                    type: integer
                  page:
                    type: integer
                  pageSize:
                    type: integer
                  totalPages:
                    type: integer
        '400':
          description: Invalid query.
        '403':
          description: A guest user, or an API key without read permission.
components:
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-token

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.