PHP (Extension) / Support API / List Brands
Back to Collection Items
<?php
include("chilkat_9_5_0.php");
$http->put_BasicAuth(true);$http->put_Login('login');$http->put_Password('password');$success = $http->QuickGetSb('https://example.zendesk.com/api/v2/brands',$sbResponseBody);$jResp->LoadSb($sbResponseBody);$jResp->put_EmitCompact(false);$jResp->put_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');$jResp->put_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;$i = $i + 1;
?>
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}"
}
]
}
