Chilkat Online Tools

Python / DocuSign REST API / Returns users from the configured Connect service.

Back to Collection Items

import sys
import chilkat2

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = chilkat2.Http()

queryParams = chilkat2.JsonObject()
queryParams.UpdateString("count","{{count}}")
queryParams.UpdateString("email_substring","{{email_substring}}")
queryParams.UpdateString("list_included_users","{{list_included_users}}")
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")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/v2.1/accounts/{{accountId}}/connect/{{connectId}}/users",queryParams)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

print(str(resp.StatusCode))
print(resp.BodyStr)

Curl Command

curl -G -d "count=%7B%7Bcount%7D%7D"
	-d "email_substring=%7B%7Bemail_substring%7D%7D"
	-d "list_included_users=%7B%7Blist_included_users%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}}/connect/{{connectId}}/users

Postman Collection Item JSON

{
  "name": "Returns users from the configured Connect service.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/connect/{{connectId}}/users?count={{count}}&email_substring={{email_substring}}&list_included_users={{list_included_users}}&start_position={{start_position}}&status={{status}}&user_name_substring={{user_name_substring}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "connect",
        "{{connectId}}",
        "users"
      ],
      "query": [
        {
          "key": "count",
          "value": "{{count}}"
        },
        {
          "key": "email_substring",
          "value": "{{email_substring}}"
        },
        {
          "key": "list_included_users",
          "value": "{{list_included_users}}"
        },
        {
          "key": "start_position",
          "value": "{{start_position}}"
        },
        {
          "key": "status",
          "value": "{{status}}"
        },
        {
          "key": "user_name_substring",
          "value": "{{user_name_substring}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "connectId",
          "value": "{{connectId}}"
        }
      ]
    },
    "description": "Returns users from the configured Connect service."
  },
  "response": [
  ]
}