Chilkat Online Tools

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

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;

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

http := CkHttp_Create();

queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'ids','externalcontact1,externalcontact2');
CkJsonObject_UpdateString(queryParams,'fields','External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal');
CkJsonObject_UpdateString(queryParams,'per_page','2"');

// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
CkHttp_SetRequestHeader(http,'X-EXTERNAL','Contacts.External_ID');

resp := CkHttp_QuickRequestParams(http,'GET','https://domain.com/crm/v2/Contacts',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);

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": [
  ]
}