PHP (Extension) / Support API / List Support Addresses
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/recipient_addresses',$sbResponseBody);$jResp->LoadSb($sbResponseBody);$jResp->put_EmitCompact(false);$jResp->put_I($i);$email = $jResp->stringOf('recipient_addresses[i].email');$brand_id = $jResp->stringOf('recipient_addresses[i].brand_id');$cname_status = $jResp->stringOf('recipient_addresses[i].cname_status');$created_at = $jResp->stringOf('recipient_addresses[i].created_at');$default = $jResp->stringOf('recipient_addresses[i].default');$dns_results = $jResp->stringOf('recipient_addresses[i].dns_results');$domain_verification_code = $jResp->stringOf('recipient_addresses[i].domain_verification_code');$domain_verification_status = $jResp->stringOf('recipient_addresses[i].domain_verification_status');$forwarding_status = $jResp->stringOf('recipient_addresses[i].forwarding_status');$id = $jResp->stringOf('recipient_addresses[i].id');$name = $jResp->stringOf('recipient_addresses[i].name');$spf_status = $jResp->stringOf('recipient_addresses[i].spf_status');$updated_at = $jResp->stringOf('recipient_addresses[i].updated_at');$i = $i + 1;
?>
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/recipient_addresses
Postman Collection Item JSON
{
"name": "List Support Addresses",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/recipient_addresses",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"recipient_addresses"
]
},
"description": "Lists all the support addresses for the account.\n\n#### 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* Admins\n* Agents\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/recipient_addresses",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"recipient_addresses"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"recipient_addresses\": [\n {\n \"email\": \"<string>\",\n \"brand_id\": \"<integer>\",\n \"cname_status\": \"failed\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"dns_results\": \"failed\",\n \"domain_verification_code\": \"<string>\",\n \"domain_verification_status\": \"unknown\",\n \"forwarding_status\": \"verified\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"spf_status\": \"verified\",\n \"updated_at\": \"<dateTime>\"\n },\n {\n \"email\": \"<string>\",\n \"brand_id\": \"<integer>\",\n \"cname_status\": \"verified\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"dns_results\": \"failed\",\n \"domain_verification_code\": \"<string>\",\n \"domain_verification_status\": \"failed\",\n \"forwarding_status\": \"verified\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"spf_status\": \"verified\",\n \"updated_at\": \"<dateTime>\"\n }\n ]\n}"
}
]
}