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/brands",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>",
' "previous_page": "<string>",
' "brands": [
' {
' "name": "<string>",
' "subdomain": "<string>",
' "active": "<boolean>",
' "brand_url": "<string>",
' "created_at": "<dateTime>",
' "default": "<boolean>",
' "has_help_center": "<boolean>",
' "help_center_state": "restricted",
' "host_mapping": "<string>",
' "id": "<integer>",
' "is_deleted": "<boolean>",
' "logo": {
' "content_type": "<string>",
' "content_url": "<string>",
' "deleted": "<boolean>",
' "file_name": "<string>",
' "height": "<string>",
' "id": "<integer>",
' "inline": "<boolean>",
' "malware_access_override": "<boolean>",
' "malware_scan_result": "<string>",
' "mapped_content_url": "<string>",
' "size": "<integer>",
' "url": "<string>",
' "width": "<string>",
' "thumbnails": [
' {
' "content_type": "<string>",
' "content_url": "<string>",
' "deleted": "<boolean>",
' "file_name": "<string>",
' "height": "<string>",
' "id": "<integer>",
' "inline": "<boolean>",
' "malware_access_override": "<boolean>",
' "malware_scan_result": "<string>",
' "mapped_content_url": "<string>",
' "size": "<integer>",
' "url": "<string>",
' "width": "<string>"
' },
' {
' "content_type": "<string>",
' "content_url": "<string>",
' "deleted": "<boolean>",
' "file_name": "<string>",
' "height": "<string>",
' "id": "<integer>",
' "inline": "<boolean>",
' "malware_access_override": "<boolean>",
' "malware_scan_result": "<string>",
' "mapped_content_url": "<string>",
' "size": "<integer>",
' "url": "<string>",
' "width": "<string>"
' }
' ]
' },
' "signature_template": "<string>",
' "ticket_form_ids": "<array>",
' "updated_at": "<dateTime>",
' "url": "<string>"
' },
' {
' "name": "<string>",
' "subdomain": "<string>",
' "active": "<boolean>",
' "brand_url": "<string>",
' "created_at": "<dateTime>",
' "default": "<boolean>",
' "has_help_center": "<boolean>",
' "help_center_state": "restricted",
' "host_mapping": "<string>",
' "id": "<integer>",
' "is_deleted": "<boolean>",
' "logo": {
' "content_type": "<string>",
' "content_url": "<string>",
' "deleted": "<boolean>",
' "file_name": "<string>",
' "height": "<string>",
' "id": "<integer>",
' "inline": "<boolean>",
' "malware_access_override": "<boolean>",
' "malware_scan_result": "<string>",
' "mapped_content_url": "<string>",
' "size": "<integer>",
' "url": "<string>",
' "width": "<string>",
' "thumbnails": [
' {
' "content_type": "<string>",
' "content_url": "<string>",
' "deleted": "<boolean>",
' "file_name": "<string>",
' "height": "<string>",
' "id": "<integer>",
' "inline": "<boolean>",
' "malware_access_override": "<boolean>",
' "malware_scan_result": "<string>",
' "mapped_content_url": "<string>",
' "size": "<integer>",
' "url": "<string>",
' "width": "<string>"
' },
' {
' "content_type": "<string>",
' "content_url": "<string>",
' "deleted": "<boolean>",
' "file_name": "<string>",
' "height": "<string>",
' "id": "<integer>",
' "inline": "<boolean>",
' "malware_access_override": "<boolean>",
' "malware_scan_result": "<string>",
' "mapped_content_url": "<string>",
' "size": "<integer>",
' "url": "<string>",
' "width": "<string>"
' }
' ]
' },
' "signature_template": "<string>",
' "ticket_form_ids": "<array>",
' "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
Dim name As String
Dim subdomain As String
Dim active As String
Dim brand_url As String
Dim created_at As String
Dim default As String
Dim has_help_center As String
Dim help_center_state As String
Dim host_mapping As String
Dim id As String
Dim is_deleted As String
Dim Content_type As String
Dim Content_url As String
Dim Deleted As String
Dim File_name As String
Dim Height As String
Dim Id As String
Dim Inline As String
Dim Malware_access_override As String
Dim Malware_scan_result As String
Dim Mapped_content_url As String
Dim Size As String
Dim v_Url As String
Dim Width As String
Dim signature_template As String
Dim ticket_form_ids As String
Dim updated_at As String
Dim url As String
Dim j As Long
Dim count_j As Long
Dim content_type As String
Dim content_url As String
Dim deleted As String
Dim file_name As String
Dim height As String
Dim inline As String
Dim malware_access_override As String
Dim malware_scan_result As String
Dim mapped_content_url As String
Dim size As String
Dim width 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("brands")
Do While i < count_i
jResp.I = i
name = jResp.StringOf("brands[i].name")
subdomain = jResp.StringOf("brands[i].subdomain")
active = jResp.StringOf("brands[i].active")
brand_url = jResp.StringOf("brands[i].brand_url")
created_at = jResp.StringOf("brands[i].created_at")
default = jResp.StringOf("brands[i].default")
has_help_center = jResp.StringOf("brands[i].has_help_center")
help_center_state = jResp.StringOf("brands[i].help_center_state")
host_mapping = jResp.StringOf("brands[i].host_mapping")
id = jResp.StringOf("brands[i].id")
is_deleted = jResp.StringOf("brands[i].is_deleted")
Content_type = jResp.StringOf("brands[i].logo.content_type")
Content_url = jResp.StringOf("brands[i].logo.content_url")
Deleted = jResp.StringOf("brands[i].logo.deleted")
File_name = jResp.StringOf("brands[i].logo.file_name")
Height = jResp.StringOf("brands[i].logo.height")
Id = jResp.StringOf("brands[i].logo.id")
Inline = jResp.StringOf("brands[i].logo.inline")
Malware_access_override = jResp.StringOf("brands[i].logo.malware_access_override")
Malware_scan_result = jResp.StringOf("brands[i].logo.malware_scan_result")
Mapped_content_url = jResp.StringOf("brands[i].logo.mapped_content_url")
Size = jResp.StringOf("brands[i].logo.size")
v_Url = jResp.StringOf("brands[i].logo.url")
Width = jResp.StringOf("brands[i].logo.width")
signature_template = jResp.StringOf("brands[i].signature_template")
ticket_form_ids = jResp.StringOf("brands[i].ticket_form_ids")
updated_at = jResp.StringOf("brands[i].updated_at")
url = jResp.StringOf("brands[i].url")
j = 0
count_j = jResp.SizeOfArray("brands[i].logo.thumbnails")
Do While j < count_j
jResp.J = j
content_type = jResp.StringOf("brands[i].logo.thumbnails[j].content_type")
content_url = jResp.StringOf("brands[i].logo.thumbnails[j].content_url")
deleted = jResp.StringOf("brands[i].logo.thumbnails[j].deleted")
file_name = jResp.StringOf("brands[i].logo.thumbnails[j].file_name")
height = jResp.StringOf("brands[i].logo.thumbnails[j].height")
id = jResp.StringOf("brands[i].logo.thumbnails[j].id")
inline = jResp.StringOf("brands[i].logo.thumbnails[j].inline")
malware_access_override = jResp.StringOf("brands[i].logo.thumbnails[j].malware_access_override")
malware_scan_result = jResp.StringOf("brands[i].logo.thumbnails[j].malware_scan_result")
mapped_content_url = jResp.StringOf("brands[i].logo.thumbnails[j].mapped_content_url")
size = jResp.StringOf("brands[i].logo.thumbnails[j].size")
url = jResp.StringOf("brands[i].logo.thumbnails[j].url")
width = jResp.StringOf("brands[i].logo.thumbnails[j].width")
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/brands
Postman Collection Item JSON
{
"name": "List Brands",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/brands",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"brands"
]
},
"description": "Returns a list of all brands for your account sorted by name.\n\n#### Allowed for\n\n* Admins, Agents"
},
"response": [
{
"name": "Successful response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/brands",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"brands"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\",\n \"brands\": [\n {\n \"name\": \"<string>\",\n \"subdomain\": \"<string>\",\n \"active\": \"<boolean>\",\n \"brand_url\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"has_help_center\": \"<boolean>\",\n \"help_center_state\": \"restricted\",\n \"host_mapping\": \"<string>\",\n \"id\": \"<integer>\",\n \"is_deleted\": \"<boolean>\",\n \"logo\": {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\",\n \"thumbnails\": [\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n },\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n }\n ]\n },\n \"signature_template\": \"<string>\",\n \"ticket_form_ids\": \"<array>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"subdomain\": \"<string>\",\n \"active\": \"<boolean>\",\n \"brand_url\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"has_help_center\": \"<boolean>\",\n \"help_center_state\": \"restricted\",\n \"host_mapping\": \"<string>\",\n \"id\": \"<integer>\",\n \"is_deleted\": \"<boolean>\",\n \"logo\": {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\",\n \"thumbnails\": [\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n },\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"deleted\": \"<boolean>\",\n \"file_name\": \"<string>\",\n \"height\": \"<string>\",\n \"id\": \"<integer>\",\n \"inline\": \"<boolean>\",\n \"malware_access_override\": \"<boolean>\",\n \"malware_scan_result\": \"<string>\",\n \"mapped_content_url\": \"<string>\",\n \"size\": \"<integer>\",\n \"url\": \"<string>\",\n \"width\": \"<string>\"\n }\n ]\n },\n \"signature_template\": \"<string>\",\n \"ticket_form_ids\": \"<array>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
