Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
Dim queryParams As New Chilkat.JsonObject
queryParams.UpdateString("documents_by_userid","{{documents_by_userid}}")
queryParams.UpdateString("include_document_size","{{include_document_size}}")
queryParams.UpdateString("include_metadata","{{include_metadata}}")
queryParams.UpdateString("include_tabs","{{include_tabs}}")
queryParams.UpdateString("recipient_id","{{recipient_id}}")
queryParams.UpdateString("shared_user_id","{{shared_user_id}}")
' Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = "{{accessToken}}"
http.SetRequestHeader("Accept","application/json")
Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents",queryParams)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Debug.WriteLine(resp.StatusCode)
Debug.WriteLine(resp.BodyStr)
Curl Command
curl -G -d "documents_by_userid=%7B%7Bdocuments_by_userid%7D%7D"
-d "include_document_size=%7B%7Binclude_document_size%7D%7D"
-d "include_metadata=%7B%7Binclude_metadata%7D%7D"
-d "include_tabs=%7B%7Binclude_tabs%7D%7D"
-d "recipient_id=%7B%7Brecipient_id%7D%7D"
-d "shared_user_id=%7B%7Bshared_user_id%7D%7D"
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents
Postman Collection Item JSON
{
"name": "Gets a list of envelope documents.",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents?documents_by_userid={{documents_by_userid}}&include_document_size={{include_document_size}}&include_metadata={{include_metadata}}&include_tabs={{include_tabs}}&recipient_id={{recipient_id}}&shared_user_id={{shared_user_id}}",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"envelopes",
"{{envelopeId}}",
"documents"
],
"query": [
{
"key": "documents_by_userid",
"value": "{{documents_by_userid}}"
},
{
"key": "include_document_size",
"value": "{{include_document_size}}"
},
{
"key": "include_metadata",
"value": "{{include_metadata}}"
},
{
"key": "include_tabs",
"value": "{{include_tabs}}"
},
{
"key": "recipient_id",
"value": "{{recipient_id}}"
},
{
"key": "shared_user_id",
"value": "{{shared_user_id}}"
}
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}",
"type": "string"
},
{
"key": "envelopeId",
"value": "{{envelopeId}}",
"type": "string"
}
]
},
"description": "Retrieves a list of documents associated with the specified envelope."
},
"response": [
]
}