VB.NET / DocuSign eSignature REST API / Gets a list of the envelopes in the specified folder.
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("from_date","{{from_date}}")
queryParams.UpdateString("include_items","{{include_items}}")
queryParams.UpdateString("owner_email","{{owner_email}}")
queryParams.UpdateString("owner_name","{{owner_name}}")
queryParams.UpdateString("search_text","{{search_text}}")
queryParams.UpdateString("start_position","{{start_position}}")
queryParams.UpdateString("status","{{status}}")
queryParams.UpdateString("to_date","{{to_date}}")
' 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}}/folders/{{folderId}}",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 "from_date=%7B%7Bfrom_date%7D%7D"
-d "include_items=%7B%7Binclude_items%7D%7D"
-d "owner_email=%7B%7Bowner_email%7D%7D"
-d "owner_name=%7B%7Bowner_name%7D%7D"
-d "search_text=%7B%7Bsearch_text%7D%7D"
-d "start_position=%7B%7Bstart_position%7D%7D"
-d "status=%7B%7Bstatus%7D%7D"
-d "to_date=%7B%7Bto_date%7D%7D"
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/folders/{{folderId}}
Postman Collection Item JSON
{
"name": "Gets a list of the envelopes in the specified folder.",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/folders/{{folderId}}?from_date={{from_date}}&include_items={{include_items}}&owner_email={{owner_email}}&owner_name={{owner_name}}&search_text={{search_text}}&start_position={{start_position}}&status={{status}}&to_date={{to_date}}",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"folders",
"{{folderId}}"
],
"query": [
{
"key": "from_date",
"value": "{{from_date}}"
},
{
"key": "include_items",
"value": "{{include_items}}"
},
{
"key": "owner_email",
"value": "{{owner_email}}"
},
{
"key": "owner_name",
"value": "{{owner_name}}"
},
{
"key": "search_text",
"value": "{{search_text}}"
},
{
"key": "start_position",
"value": "{{start_position}}"
},
{
"key": "status",
"value": "{{status}}"
},
{
"key": "to_date",
"value": "{{to_date}}"
}
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}",
"type": "string"
},
{
"key": "folderId",
"value": "{{folderId}}",
"type": "string"
}
]
},
"description": "Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters."
},
"response": [
]
}