Skip to main content
Question

GET /envelopes/{envelopeId} returns empty comments array in commentThreadTabs

  • January 7, 2026
  • 1 reply
  • 38 views

Forum|alt.badge.img

Hi everyone,

I’m running into an issue where I cannot retrieve the actual comment data from an envelope using the primary Get Envelope endpoint, even when including all relevant parameters.

The Goal: I want to retrieve the contents of commentThreadTabs (specifically the comments array) in a single request to avoid making multiple calls per envelope.

The Problem: When calling GET /v2.1/accounts/{accountId}/envelopes/{envelopeId} with the following query parameters: ?include=workflow,documents,custom_fields,recipients,tabs,prefill_tabs

The response returns the commentThreadTabs object, but the comments array inside it is always empty.

Observations:

  • If I use the specific GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs endpoint, the comments are populated correctly.

  • However, the documentation for the main Get Envelope endpoint implies that include=tabs should return the full tab schema, which includes the comment threads.

Questions:

  1. Is it by design that the comments array within commentThreadTabs is excluded from the main Envelope response?

  2. Is there a specific include value or header required to "hydrate" these comment arrays in a single call?

Any insights would be greatly appreciated!

1 reply

Forum|alt.badge.img+5
  • Docusign Employee
  • January 9, 2026

Hi @maxf

Thanks for reaching out to Docusign Community.

Although the tabs parameter on the GetEnvelope call returns the tabs associated with the envelope, the full tab data is available in the specific /tabs endpoint. Currently, there is no other parameter that can include the comment array in the GetEnvelope API call.

Best regards,