Chilkat Online Tools

phpExt / Zoho CRM REST APIs / Custom

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

$queryParams = new CkJsonObject();
$queryParams->UpdateString('module','{{Custom_module_API_name}}');

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');

// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://domain.com/crm/v2.1/settings/related_lists',$queryParams);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -G -d "module=%7B%7BCustom_module_API_name%7D%7D"
	-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/settings/related_lists

Postman Collection Item JSON

{
  "name": "Custom",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/settings/related_lists?module={{Custom_module_API_name}}",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "settings",
        "related_lists"
      ],
      "query": [
        {
          "key": "module",
          "value": "{{Custom_module_API_name}}"
        }
      ]
    },
    "description": "To get the metadata of the custom module."
  },
  "response": [
  ]
}