Chilkat Online Tools

Objective-C / Zoho CRM REST APIs / Using External Field's Value

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"fields" value: @"External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal"];
[queryParams UpdateInt: @"per_page" value: [NSNumber numberWithInt: 2]];

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"X-EXTERNAL" value: @"Contacts.External_ID"];

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://domain.com/crm/v2/Contacts/externalcontact1" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

Curl Command

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

Postman Collection Item JSON

{
  "name": "Using External Field's Value",
  "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/externalcontact1?fields=External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal&per_page=2",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Contacts",
        "externalcontact1"
      ],
      "query": [
        {
          "key": "fields",
          "value": "External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal"
        },
        {
          "key": "per_page",
          "value": "2"
        }
      ]
    },
    "description": "To fetch a record through the external field's value. In this example, Contacts is the base module's API name, External_Contact_ID is the API name of the external field, and externalcontact1 is the value of the external field in this module."
  },
  "response": [
  ]
}