Clicksign icon

Clicksign

Interact with Clicksign API

Envelope → Listar

AI-generated

Summary

Retrieve a list of envelopes, optionally filtering by status, name, creation date, modification date, deadline, and sorting the results by specified envelope properties.

Inputs

  • Filtro Status — Filter the envelopes by status; allowed values are draft, running, closed, canceled.
  • Filtro Nome — Filter envelopes by the exact full name.
  • Filtro Data De Criação — Filter envelopes by creation date range in ISO 8601 format, separated by commas.
  • Filtro Data De Modificação — Filter envelopes by last modification date range in ISO 8601 format, separated by commas.
  • Filtro Prazo Final — Filter envelopes by deadline date range in ISO 8601 format, separated by commas.
  • Ordenação — Sort envelopes by a specified property; prefix the property with '-' for descending order.

Output shape

a list of envelope records matching the applied filters and sorting criteria

The operation returns a JSON array containing envelope objects filtered and sorted per provided inputs; if no filters are set, it returns all envelopes. Pagination and detailed error handling are not specified.

Discussion