Chilkat Online Tools

VB6 / Support API / List Organizations

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 ChilkatHttp
Dim success As Long

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

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

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/organizations",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

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

' {
'   "count": "<integer>",
'   "next_page": "<string>",
'   "organizations": [
'     {
'       "created_at": "<string>",
'       "details": "<string>",
'       "domain_names": [
'         "<string>",
'         "<string>"
'       ],
'       "external_id": "<string>",
'       "group_id": "<integer>",
'       "id": "<integer>",
'       "name": "<string>",
'       "notes": "<string>",
'       "organization_fields": {
'         "eiusmod_f": "<string>"
'       },
'       "shared_comments": "<boolean>",
'       "shared_tickets": "<boolean>",
'       "tags": [
'         "<string>",
'         "<string>"
'       ],
'       "updated_at": "<string>",
'       "url": "<string>"
'     },
'     {
'       "created_at": "<string>",
'       "details": "<string>",
'       "domain_names": [
'         "<string>",
'         "<string>"
'       ],
'       "external_id": "<string>",
'       "group_id": "<integer>",
'       "id": "<integer>",
'       "name": "<string>",
'       "notes": "<string>",
'       "organization_fields": {
'         "nulla2": "<string>"
'       },
'       "shared_comments": "<boolean>",
'       "shared_tickets": "<boolean>",
'       "tags": [
'         "<string>",
'         "<string>"
'       ],
'       "updated_at": "<string>",
'       "url": "<string>"
'     }
'   ],
'   "previous_page": "<string>"
' }

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

Dim created_at As String
Dim details As String
Dim external_id As String
Dim group_id As String
Dim id As String
Dim name As String
Dim notes As String
Dim Eiusmod_f As String
Dim shared_comments As String
Dim shared_tickets As String
Dim updated_at As String
Dim url As String
Dim Nulla2 As String
Dim j As Long
Dim count_j As Long
Dim strVal As String

Dim count As String
count = jResp.StringOf("count")
Dim next_page As String
next_page = jResp.StringOf("next_page")
Dim previous_page As String
previous_page = jResp.StringOf("previous_page")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("organizations")
Do While i < count_i
    jResp.I = i
    created_at = jResp.StringOf("organizations[i].created_at")
    details = jResp.StringOf("organizations[i].details")
    external_id = jResp.StringOf("organizations[i].external_id")
    group_id = jResp.StringOf("organizations[i].group_id")
    id = jResp.StringOf("organizations[i].id")
    name = jResp.StringOf("organizations[i].name")
    notes = jResp.StringOf("organizations[i].notes")
    Eiusmod_f = jResp.StringOf("organizations[i].organization_fields.eiusmod_f")
    shared_comments = jResp.StringOf("organizations[i].shared_comments")
    shared_tickets = jResp.StringOf("organizations[i].shared_tickets")
    updated_at = jResp.StringOf("organizations[i].updated_at")
    url = jResp.StringOf("organizations[i].url")
    Nulla2 = jResp.StringOf("organizations[i].organization_fields.nulla2")
    j = 0
    count_j = jResp.SizeOfArray("organizations[i].domain_names")
    Do While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("organizations[i].domain_names[j]")
        j = j + 1
    Loop
    j = 0
    count_j = jResp.SizeOfArray("organizations[i].tags")
    Do While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("organizations[i].tags[j]")
        j = j + 1
    Loop
    i = i + 1
Loop

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Organizations",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organizations",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organizations"
      ]
    },
    "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* Agents, with certain restrictions\n\nIf the agent has a custom agent role that restricts their access to only users in their own organization, a 403 Forbidden error is returned. See [Creating custom agent roles](https://support.zendesk.com/hc/en-us/articles/203662026-Creating-custom-roles-and-assigning-agents#topic_cxn_hig_bd) in Zendesk help.\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/organizations",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organizations"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"organizations\": [\n    {\n      \"created_at\": \"<string>\",\n      \"details\": \"<string>\",\n      \"domain_names\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"external_id\": \"<string>\",\n      \"group_id\": \"<integer>\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"notes\": \"<string>\",\n      \"organization_fields\": {\n        \"eiusmod_f\": \"<string>\"\n      },\n      \"shared_comments\": \"<boolean>\",\n      \"shared_tickets\": \"<boolean>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"created_at\": \"<string>\",\n      \"details\": \"<string>\",\n      \"domain_names\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"external_id\": \"<string>\",\n      \"group_id\": \"<integer>\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"notes\": \"<string>\",\n      \"organization_fields\": {\n        \"nulla2\": \"<string>\"\n      },\n      \"shared_comments\": \"<boolean>\",\n      \"shared_tickets\": \"<boolean>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\"\n    }\n  ],\n  \"previous_page\": \"<string>\"\n}"
    }
  ]
}