Chilkat Online Tools

TCL / Zoho CRM REST APIs / Search Using Email

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateString $queryParams "email" "patricia.boyle@zylker.com"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpParams $http "GET" "https://domain.com/crm/v2.1/Leads/search" $queryParams $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    delete_CkHttpResponse $resp
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]

delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkHttpResponse $resp

Curl Command

curl -G -d "email=patricia.boyle%40zylker.com"
	-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/Leads/search

Postman Collection Item JSON

{
  "name": "Search Using Email",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/Leads/search?email=patricia.boyle@zylker.com",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "Leads",
        "search"
      ],
      "query": [
        {
          "key": "email",
          "value": "patricia.boyle@zylker.com"
        }
      ]
    },
    "description": "Performs search using Email."
  },
  "response": [
  ]
}