ATatlaswork
envelopes

List envelopes

Changed on

Cursor-paginated list of the organization's envelopes, ordered by createdAt descending. Pass nextCursor from the previous page as cursor; limit is capped at 100 (default 50). Filter by lifecycle status with status (one or more statuses, comma-separated), and by name with q (case-insensitive substring of the display name or the original filename).

get/api/v1/envelopes

Request

  • Base URL
    https://api.atlaswork.ai
  • URL
    https://api.atlaswork.ai/api/v1/envelopes
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

cursorstring
limitinteger
statusstring
qstring
view'attention' | 'waiting' | 'drafts' | 'completed' | 'all'
senderstring
teamstring
recipientstring
templatestring
fromstring date-time
tostring date-time
attentionstring
sort'created' | 'sent' | 'completed' | 'activity' | 'name' | 'urgency'

Response

One page of envelopes

nextCursorstring

Changes

  • d3b4f91b9bb2Revision changes
    • warning

      added the new skipped enum value to the // response property for the response status

    • info

      added the new optional query request parameter attention

    • info

      added the new optional query request parameter from

    • info

      added the new optional query request parameter q

    • info

      added the new optional query request parameter recipient

    • info

      added the new optional query request parameter sender

    • info

      added the new optional query request parameter sort

    • info

      added the new optional query request parameter team

    • info

      added the new optional query request parameter template

    • info

      added the new optional query request parameter to

    • info

      added the new optional query request parameter view

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status