autoit / Support API / List Brands
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/brands",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sName
Local $subdomain
Local $sActive
Local $sBrand_url
Local $sCreated_at
Local $sDefault
Local $sHas_help_center
Local $sHelp_center_state
Local $sHost_mapping
Local $sId
Local $sIs_deleted
Local $sContent_type
Local $sContent_url
Local $sDeleted
Local $sFile_name
Local $sHeight
Local $sId
Local $sInline
Local $sMalware_access_override
Local $sMalware_scan_result
Local $sMapped_content_url
Local $sSize
Local $sV_Url
Local $sWidth
Local $signature_template
Local $sTicket_form_ids
Local $sUpdated_at
Local $sUrl
Local $iJ
Local $iCount_j
Local $sContent_type
Local $sContent_url
Local $sDeleted
Local $sFile_name
Local $sHeight
Local $sInline
Local $sMalware_access_override
Local $sMalware_scan_result
Local $sMapped_content_url
Local $size
Local $sWidth
Local $sCount = $oJResp.StringOf("count")
Local $sNext_page = $oJResp.StringOf("next_page")
Local $sPrevious_page = $oJResp.StringOf("previous_page")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("brands")
While $i < $iCount_i
$oJResp.I = $i
$sName = $oJResp.StringOf("brands[i].name")
$subdomain = $oJResp.StringOf("brands[i].subdomain")
$sActive = $oJResp.StringOf("brands[i].active")
$sBrand_url = $oJResp.StringOf("brands[i].brand_url")
$sCreated_at = $oJResp.StringOf("brands[i].created_at")
$sDefault = $oJResp.StringOf("brands[i].default")
$sHas_help_center = $oJResp.StringOf("brands[i].has_help_center")
$sHelp_center_state = $oJResp.StringOf("brands[i].help_center_state")
$sHost_mapping = $oJResp.StringOf("brands[i].host_mapping")
$sId = $oJResp.StringOf("brands[i].id")
$sIs_deleted = $oJResp.StringOf("brands[i].is_deleted")
$sContent_type = $oJResp.StringOf("brands[i].logo.content_type")
$sContent_url = $oJResp.StringOf("brands[i].logo.content_url")
$sDeleted = $oJResp.StringOf("brands[i].logo.deleted")
$sFile_name = $oJResp.StringOf("brands[i].logo.file_name")
$sHeight = $oJResp.StringOf("brands[i].logo.height")
$sId = $oJResp.StringOf("brands[i].logo.id")
$sInline = $oJResp.StringOf("brands[i].logo.inline")
$sMalware_access_override = $oJResp.StringOf("brands[i].logo.malware_access_override")
$sMalware_scan_result = $oJResp.StringOf("brands[i].logo.malware_scan_result")
$sMapped_content_url = $oJResp.StringOf("brands[i].logo.mapped_content_url")
$sSize = $oJResp.StringOf("brands[i].logo.size")
$sV_Url = $oJResp.StringOf("brands[i].logo.url")
$sWidth = $oJResp.StringOf("brands[i].logo.width")
$signature_template = $oJResp.StringOf("brands[i].signature_template")
$sTicket_form_ids = $oJResp.StringOf("brands[i].ticket_form_ids")
$sUpdated_at = $oJResp.StringOf("brands[i].updated_at")
$sUrl = $oJResp.StringOf("brands[i].url")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("brands[i].logo.thumbnails")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sContent_type = $oJResp.StringOf("brands[i].logo.thumbnails[j].content_type")
$sContent_url = $oJResp.StringOf("brands[i].logo.thumbnails[j].content_url")
$sDeleted = $oJResp.StringOf("brands[i].logo.thumbnails[j].deleted")
$sFile_name = $oJResp.StringOf("brands[i].logo.thumbnails[j].file_name")
$sHeight = $oJResp.StringOf("brands[i].logo.thumbnails[j].height")
$sId = $oJResp.StringOf("brands[i].logo.thumbnails[j].id")
$sInline = $oJResp.StringOf("brands[i].logo.thumbnails[j].inline")
$sMalware_access_override = $oJResp.StringOf("brands[i].logo.thumbnails[j].malware_access_override")
$sMalware_scan_result = $oJResp.StringOf("brands[i].logo.thumbnails[j].malware_scan_result")
$sMapped_content_url = $oJResp.StringOf("brands[i].logo.thumbnails[j].mapped_content_url")
$size = $oJResp.StringOf("brands[i].logo.thumbnails[j].size")
$sUrl = $oJResp.StringOf("brands[i].logo.thumbnails[j].url")
$sWidth = $oJResp.StringOf("brands[i].logo.thumbnails[j].width")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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}"
}
]
}
