Chilkat Online Tools

VB.NET / DocuSign eSignature REST API / Retrieves the list of users for the specified account.

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("additional_info","{{additional_info}}")
queryParams.UpdateString("count","{{count}}")
queryParams.UpdateString("email","{{email}}")
queryParams.UpdateString("email_substring","{{email_substring}}")
queryParams.UpdateString("group_id","{{group_id}}")
queryParams.UpdateString("include_usersettings_for_csv","{{include_usersettings_for_csv}}")
queryParams.UpdateString("login_status","{{login_status}}")
queryParams.UpdateString("not_group_id","{{not_group_id}}")
queryParams.UpdateString("start_position","{{start_position}}")
queryParams.UpdateString("status","{{status}}")
queryParams.UpdateString("user_name_substring","{{user_name_substring}}")

' 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}}/users",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 "additional_info=%7B%7Badditional_info%7D%7D"
	-d "count=%7B%7Bcount%7D%7D"
	-d "email=%7B%7Bemail%7D%7D"
	-d "email_substring=%7B%7Bemail_substring%7D%7D"
	-d "group_id=%7B%7Bgroup_id%7D%7D"
	-d "include_usersettings_for_csv=%7B%7Binclude_usersettings_for_csv%7D%7D"
	-d "login_status=%7B%7Blogin_status%7D%7D"
	-d "not_group_id=%7B%7Bnot_group_id%7D%7D"
	-d "start_position=%7B%7Bstart_position%7D%7D"
	-d "status=%7B%7Bstatus%7D%7D"
	-d "user_name_substring=%7B%7Buser_name_substring%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/users

Postman Collection Item JSON

{
  "name": "Retrieves the list of users for the specified account.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/users?additional_info={{additional_info}}&count={{count}}&email={{email}}&email_substring={{email_substring}}&group_id={{group_id}}&include_usersettings_for_csv={{include_usersettings_for_csv}}&login_status={{login_status}}&not_group_id={{not_group_id}}&start_position={{start_position}}&status={{status}}&user_name_substring={{user_name_substring}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "users"
      ],
      "query": [
        {
          "key": "additional_info",
          "value": "{{additional_info}}"
        },
        {
          "key": "count",
          "value": "{{count}}"
        },
        {
          "key": "email",
          "value": "{{email}}"
        },
        {
          "key": "email_substring",
          "value": "{{email_substring}}"
        },
        {
          "key": "group_id",
          "value": "{{group_id}}"
        },
        {
          "key": "include_usersettings_for_csv",
          "value": "{{include_usersettings_for_csv}}"
        },
        {
          "key": "login_status",
          "value": "{{login_status}}"
        },
        {
          "key": "not_group_id",
          "value": "{{not_group_id}}"
        },
        {
          "key": "start_position",
          "value": "{{start_position}}"
        },
        {
          "key": "status",
          "value": "{{status}}"
        },
        {
          "key": "user_name_substring",
          "value": "{{user_name_substring}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        }
      ]
    },
    "description": "Retrieves the list of users for the specified account.\n\nThe response returns the list of users for the account along with the information about the result set. If the `additional_info` query was added to the endpoint and set to **true**, the full user information is returned for each user"
  },
  "response": [
  ]
}