Chilkat Online Tools

Python / Support API / List Groups

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()

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

http.SetRequestHeader("Accept","application/json")

sbResponseBody = chilkat2.StringBuilder()
success = http.QuickGetSb("https://example.zendesk.com/api/v2/groups",sbResponseBody)
if (success == False):
    print(http.LastErrorText)
    sys.exit()

jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

print("Response Body:")
print(jResp.Emit())

respStatusCode = http.LastStatus
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(http.LastHeader)
    print("Failed.")
    sys.exit()

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "groups": [
#     {
#       "name": "<string>",
#       "created_at": "<dateTime>",
#       "default": "<boolean>",
#       "deleted": "<boolean>",
#       "description": "<string>",
#       "id": "<integer>",
#       "is_public": "<boolean>",
#       "updated_at": "<dateTime>",
#       "url": "<string>"
#     },
#     {
#       "name": "<string>",
#       "created_at": "<dateTime>",
#       "default": "<boolean>",
#       "deleted": "<boolean>",
#       "description": "<string>",
#       "id": "<integer>",
#       "is_public": "<boolean>",
#       "updated_at": "<dateTime>",
#       "url": "<string>"
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

i = 0
count_i = jResp.SizeOfArray("groups")
while i < count_i :
    jResp.I = i
    name = jResp.StringOf("groups[i].name")
    created_at = jResp.StringOf("groups[i].created_at")
    default = jResp.StringOf("groups[i].default")
    deleted = jResp.StringOf("groups[i].deleted")
    description = jResp.StringOf("groups[i].description")
    id = jResp.StringOf("groups[i].id")
    is_public = jResp.StringOf("groups[i].is_public")
    updated_at = jResp.StringOf("groups[i].updated_at")
    url = jResp.StringOf("groups[i].url")
    i = i + 1

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/groups

Postman Collection Item JSON

{
  "name": "List Groups",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/groups",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "groups"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>",
          "description": "(Required) The id of the user"
        },
        {
          "key": "exclude_deleted",
          "value": "<boolean>",
          "description": "Whether to exclude deleted entities"
        }
      ]
    },
    "description": "#### Pagination\n\n* Cursor pagination (recommended)\n* Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n\n* Admins\n* Agents\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/groups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "groups"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"groups\": [\n    {\n      \"name\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"deleted\": \"<boolean>\",\n      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"deleted\": \"<boolean>\",\n      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}