Common API Components

Understand the common components used in CleverTap APIs.

CleverTap APIs contain several common components in their design and usage.
This page details the common components available in CleverTap APIs.


The following table lists your API endpoint based on the region of your account:

RegionAPI EndpointCleverTap Dashboard URL
United Statesus1.api.clevertap.com
Middle East (UAE)mec1.api.clevertap.com
Europe (default region)api.clevertap.com

API Headers

The API headers are used while processing the API request. The below headers are required when you use CleverTap APIs:

The X-CleverTap-Account-Id and X-CleverTap-Passcode authenticate the request.

HeaderDescriptionTypeExample Value
X-CleverTap-Account-IdYour CleverTap Account ID.string"X-CleverTap-Account-Id: ACCOUNT_ID"
X-CleverTap-PasscodeYour CleverTap Account Passcode.string"X-CleverTap-Passcode: PASSCODE"
Content-TypeRequest content-type is always set to application/json.string"Content-Type: application/json"

Refer to the API Authentication to obtain the header values. To understand the common queries and concerns related to CleverTap APIs, refer to API FAQs.