Chilkat Online Tools

Python / DocuSign eSignature REST API / Gets information about groups associated with the account.

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("group_type","{{group_type}}")
queryParams.UpdateString("include_usercount","{{include_usercount}}")
queryParams.UpdateString("search_text","{{search_text}}")
queryParams.UpdateString("start_position","{{start_position}}")

# 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}}/groups",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 "group_type=%7B%7Bgroup_type%7D%7D"
	-d "include_usercount=%7B%7Binclude_usercount%7D%7D"
	-d "search_text=%7B%7Bsearch_text%7D%7D"
	-d "start_position=%7B%7Bstart_position%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/groups

Postman Collection Item JSON

{
  "name": "Gets information about groups associated with the account.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/groups?count={{count}}&group_type={{group_type}}&include_usercount={{include_usercount}}&search_text={{search_text}}&start_position={{start_position}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "groups"
      ],
      "query": [
        {
          "key": "count",
          "value": "{{count}}"
        },
        {
          "key": "group_type",
          "value": "{{group_type}}"
        },
        {
          "key": "include_usercount",
          "value": "{{include_usercount}}"
        },
        {
          "key": "search_text",
          "value": "{{search_text}}"
        },
        {
          "key": "start_position",
          "value": "{{start_position}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        }
      ]
    },
    "description": "Retrieves information about groups associated with the account."
  },
  "response": [
  ]
}