Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
queryParams := TChilkatJsonObject.Create(Self);
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 := http.QuickRequestParams('GET','https://domain.com/crm/v2/Contacts',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
Memo1.Lines.Add(IntToStr(resp.StatusCode));
Memo1.Lines.Add(resp.BodyStr);
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": [
]
}