Overview

This API retrieves CleverTap user details. You can:

• Fetch a specific user by email address, or
• Retrieve a paginated list of users with optional SCIM-compliant filtering.

HTTP Method

GET

Endpoint

• List users: /nx/v2/scim/v2/Users
• Get user by email: /nx/v2/scim/v2/Users/{email}

Base URL

The following is an example base URL for a CleverTap account in the United States region:

https://<clevertap_domain>/nx/v2/scim/v2/Users

Example: https://us1.dashboard.clevertap.com/nx/v2/scim/v2/Users

🚧

Region-Specific

The CleverTap domain is environment- and region-specific. Do not copy the example URL directly. Always replace <clevertap_domain> with the domain for your region. Refer Region for more details.

Headers

The following headers must be included with every API request:

Replace <SCIM_TOKEN> with a valid SCIM Bearer token generated from the CleverTap dashboard. Refer to Generate SCIM Token for API-Based Provisioning.

Example Request (Get User by Email)

The following is the sample request:

curl -X GET /nx/v2/scim/v2/Users/[email protected] \
-H "Authorization: Bearer <SCIM_TOKEN>" \
-H "Content-Type: application/scim+json"

Path Parameters

The following is the list of path parameters:

Example Response 1

The following is the sample response:

{
  "id": "user-unique-id",
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "userName": "[email protected]",
  "name": {
    "givenName": "John",
    "familyName": "Doe"
  },
  "active": true,
  "accounts": [
    {
      "accountId": "CLEVERTAP_ACCOUNT_ID",
      "roles": "Admin,Editor",
      "teams": "Engineering,Product",
      "status": "Active"
    }
  ],
  "invitedBy": "[email protected]"
}

Example Request 2 (List Users)

The following is the sample request with a query parameter:

curl -X GET "https://<clevertap_domain>/nx/v2/scim/v2/Users?startIndex=0&count=20" \
-H "Authorization: Bearer <SCIM_TOKEN>" \
-H "Content-Type: application/scim+json"

Query Parameters

The following is the list of query parameters:

Example Response 2

The following is the sample response:

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults": 50,
  "startIndex": 0,
  "itemsPerPage": 20,
  "resources": [
    {
      "id": "user-unique-id",
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
      "name": {
        "givenName": "John",
        "familyName": "Doe"
      },
      "active": true,
      "accounts": [
        {
          "accountId": "CLEVERTAP_ACCOUNT_ID",
          "roles": "Admin,Editor",
          "teams": "Engineering,Product",
          "status": "Active"
        }
      ],
      "invitedBy": "[email protected]"
    }
  ]
}

Response Parameters

The following is the list of response parameters:

Error Codes

The following is the list of error codes and responses: