Chilkat Online Tools

delphiDll / Zoho CRM REST APIs / Using the external value and the "equals" operator in "criteria"

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,'criteria','(External_Contact_ID:equals:usercontact2)');
CkJsonObject_UpdateString(queryParams,'fields','External_Contact_ID,Email');

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

resp := CkHttp_QuickRequestParams(http,'GET','https://domain.com/crm/v2/Contacts/search',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 "criteria=%28External_Contact_ID%3Aequals%3Ausercontact2%29"
	-d "fields=External_Contact_ID,Email"
	-H "Authorization: Bearer <access_token>"
	-H "X-EXTERNAL: Contacts.External_Contact_ID"
https://domain.com/crm/v2/Contacts/search

Postman Collection Item JSON

{
  "name": "Using the external value and the \"equals\" operator in \"criteria\"",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "X-EXTERNAL",
        "value": "Contacts.External_Contact_ID",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{api-domain}}/crm/v2/Contacts/search?criteria=(External_Contact_ID:equals:usercontact2)&fields=External_Contact_ID,Email",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Contacts",
        "search"
      ],
      "query": [
        {
          "key": "criteria",
          "value": "(External_Contact_ID:equals:usercontact2)"
        },
        {
          "key": "fields",
          "value": "External_Contact_ID,Email"
        }
      ]
    },
    "description": "Parameter:criteria=(External_Contact_ID:equals:usercontact123)"
  },
  "response": [
  ]
}