Chilkat Online Tools

phpAx / Zoho CRM REST APIs / Using "ids" Parameter

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$queryParams = new COM("Chilkat.JsonObject");
$queryParams->UpdateString('ids','externalcontact1,externalcontact2');
$queryParams->UpdateString('fields','External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal');
$queryParams->UpdateString('per_page','2\'');

// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
$http->SetRequestHeader('X-EXTERNAL','Contacts.External_ID');

// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequestParams('GET','https://domain.com/crm/v2/Contacts',$queryParams);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -G -d "ids=externalcontact1,externalcontact2"
	-d "fields=External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal"
	-d "per_page=2%22"
	-H "Authorization: Bearer <access_token>"
	-H "X-EXTERNAL: Contacts.External_ID"
https://domain.com/crm/v2/Contacts

Postman Collection Item JSON

{
  "name": "Using \"ids\" Parameter",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "X-EXTERNAL",
        "value": "Contacts.External_ID",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{api-domain}}/crm/v2/Contacts?ids=externalcontact1,externalcontact2&fields=External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal&per_page=2\"",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Contacts"
      ],
      "query": [
        {
          "key": "ids",
          "value": "externalcontact1,externalcontact2"
        },
        {
          "key": "fields",
          "value": "External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal"
        },
        {
          "key": "per_page",
          "value": "2\""
        }
      ]
    },
    "description": "In this example, Contacts is the base module's API name, External_Contact_ID is the API name of the external field. The \"ids\" parameter fetches the records with the external values externalcontact1 and externalcontact2."
  },
  "response": [
  ]
}