Chilkat Online Tools

VB.NET / DocuSign eSignature REST API / Gets recipient information from a template.

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("include_anchor_tab_locations","{{include_anchor_tab_locations}}")
queryParams.UpdateString("include_extended","{{include_extended}}")
queryParams.UpdateString("include_tabs","{{include_tabs}}")

' 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}}/templates/{{templateId}}/recipients",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 "include_anchor_tab_locations=%7B%7Binclude_anchor_tab_locations%7D%7D"
	-d "include_extended=%7B%7Binclude_extended%7D%7D"
	-d "include_tabs=%7B%7Binclude_tabs%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/recipients

Postman Collection Item JSON

{
  "name": "Gets recipient information from a template.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/templates/{{templateId}}/recipients?include_anchor_tab_locations={{include_anchor_tab_locations}}&include_extended={{include_extended}}&include_tabs={{include_tabs}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "templates",
        "{{templateId}}",
        "recipients"
      ],
      "query": [
        {
          "key": "include_anchor_tab_locations",
          "value": "{{include_anchor_tab_locations}}"
        },
        {
          "key": "include_extended",
          "value": "{{include_extended}}"
        },
        {
          "key": "include_tabs",
          "value": "{{include_tabs}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "templateId",
          "value": "{{templateId}}",
          "type": "string"
        }
      ]
    },
    "description": "Retrieves the information for all recipients in the specified template."
  },
  "response": [
  ]
}