PHP (Extension) / Support API / Show a Sharing Agreement
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/sharing_agreements/:sharing_agreement_id',$sbResponseBody);$jResp->LoadSb($sbResponseBody);$jResp->put_EmitCompact(false);
?>
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/sharing_agreements/:sharing_agreement_id
Postman Collection Item JSON
{
"name": "Show a Sharing Agreement",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sharing_agreements/:sharing_agreement_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sharing_agreements",
":sharing_agreement_id"
],
"variable": [
{
"key": "sharing_agreement_id",
"value": "<integer>"
}
]
},
"description": "Returns a sharing agreement for your account.\n\n#### Allowed For\n\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/sharing_agreements/:sharing_agreement_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sharing_agreements",
":sharing_agreement_id"
],
"variable": [
{
"key": "sharing_agreement_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"sharing_agreement\": {\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"partner_name\": \"<string>\",\n \"remote_subdomain\": \"<string>\",\n \"status\": \"<string>\",\n \"type\": \"<string>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}