Chilkat Online Tools

Delphi (DLL) / Support API / List Brands

Back to Collection Items

var

begin
CkHttp_putBasicAuth(http,True);CkHttp_putLogin(http,'login');CkHttp_putPassword(http,'password');success := CkHttp_QuickGetSb(http,'https://example.zendesk.com/api/v2/brands',sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);name := CkJsonObject__stringOf(jResp,'brands[i].name');subdomain := CkJsonObject__stringOf(jResp,'brands[i].subdomain');active := CkJsonObject__stringOf(jResp,'brands[i].active');brand_url := CkJsonObject__stringOf(jResp,'brands[i].brand_url');created_at := CkJsonObject__stringOf(jResp,'brands[i].created_at');default := CkJsonObject__stringOf(jResp,'brands[i].default');has_help_center := CkJsonObject__stringOf(jResp,'brands[i].has_help_center');help_center_state := CkJsonObject__stringOf(jResp,'brands[i].help_center_state');host_mapping := CkJsonObject__stringOf(jResp,'brands[i].host_mapping');id := CkJsonObject__stringOf(jResp,'brands[i].id');is_deleted := CkJsonObject__stringOf(jResp,'brands[i].is_deleted');Content_type := CkJsonObject__stringOf(jResp,'brands[i].logo.content_type');Content_url := CkJsonObject__stringOf(jResp,'brands[i].logo.content_url');Deleted := CkJsonObject__stringOf(jResp,'brands[i].logo.deleted');File_name := CkJsonObject__stringOf(jResp,'brands[i].logo.file_name');Height := CkJsonObject__stringOf(jResp,'brands[i].logo.height');Id := CkJsonObject__stringOf(jResp,'brands[i].logo.id');Inline := CkJsonObject__stringOf(jResp,'brands[i].logo.inline');Malware_access_override := CkJsonObject__stringOf(jResp,'brands[i].logo.malware_access_override');Malware_scan_result := CkJsonObject__stringOf(jResp,'brands[i].logo.malware_scan_result');Mapped_content_url := CkJsonObject__stringOf(jResp,'brands[i].logo.mapped_content_url');Size := CkJsonObject__stringOf(jResp,'brands[i].logo.size');v_Url := CkJsonObject__stringOf(jResp,'brands[i].logo.url');Width := CkJsonObject__stringOf(jResp,'brands[i].logo.width');signature_template := CkJsonObject__stringOf(jResp,'brands[i].signature_template');ticket_form_ids := CkJsonObject__stringOf(jResp,'brands[i].ticket_form_ids');updated_at := CkJsonObject__stringOf(jResp,'brands[i].updated_at');url := CkJsonObject__stringOf(jResp,'brands[i].url');j := 0;count_j := CkJsonObject_SizeOfArray(jResp,'brands[i].logo.thumbnails');CkJsonObject_putJ(jResp,j);content_type := CkJsonObject__stringOf(jResp,'brands[i].logo.thumbnails[j].content_type');content_url := CkJsonObject__stringOf(jResp,'brands[i].logo.thumbnails[j].content_url');deleted := CkJsonObject__stringOf(jResp,'brands[i].logo.thumbnails[j].deleted');file_name := CkJsonObject__stringOf(jResp,'brands[i].logo.thumbnails[j].file_name');height := CkJsonObject__stringOf(jResp,'brands[i].logo.thumbnails[j].height');id := CkJsonObject__stringOf(jResp,'brands[i].logo.thumbnails[j].id');inline := CkJsonObject__stringOf(jResp,'brands[i].logo.thumbnails[j].inline');malware_access_override := CkJsonObject__stringOf(jResp,'brands[i].logo.thumbnails[j].malware_access_override');malware_scan_result := CkJsonObject__stringOf(jResp,'brands[i].logo.thumbnails[j].malware_scan_result');mapped_content_url := CkJsonObject__stringOf(jResp,'brands[i].logo.thumbnails[j].mapped_content_url');size := CkJsonObject__stringOf(jResp,'brands[i].logo.thumbnails[j].size');url := CkJsonObject__stringOf(jResp,'brands[i].logo.thumbnails[j].url');width := CkJsonObject__stringOf(jResp,'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}"
    }
  ]
}