Skip to content
/
OAuth 2.0 for Customers
Last updated

Generate an API Key and Secret

API keys and secrets allow your application to authenticate with Sprinklr APIs. After you create an API key and secret, you can generate an access token and start making API requests.

Before You Begin

Make sure that you:

  • Have access to the Sprinklr Developer Portal.
  • Have the required permissions to create API credentials.
  • Know the environment ({env}) that you want to connect to.

Generate an API Key and Secret

  1. Sign in to your Sprinklr Environment.
  2. Navigate to Developer Tools.
  3. Select Create App or open an existing application.
  4. In the application's Credentials section, select Generate API Key.
  5. Copy the generated:
    • API Key
    • API Secret
  6. Store the API key and secret securely. You will use them to generate access tokens for API authentication.

Note: Key generation is no longer available in the Developer Portal. To generate or manage keys, use the Developer Tools options available in the Sprinklr platform as mentioned in document below. To view keys previously generated through the legacy Developer Portal, click here For detailed information on API Key and Secret generation, refer to, Developer Tools in Sprinklr

Generate an Access Token

Use your API key and secret to generate an access token through the supported authentication flow.

After you receive the access token, include it in the Authorization header when making API requests.

Make Your First API Call

After generating your API key, secret, and access token, you can verify your setup by making a simple API request.

Send a GET request to the /me endpoint to retrieve information about the authenticated user.

Request

curl -X GET \
    'https://api3.sprinklr.com/{env}/api/v2/me' \
    -H 'Authorization: Bearer {token}' \
    -H 'cache-control: no-cache' \
    -H 'key: {apikey}'

Request Parameters

ParameterDescription
{env}The Sprinklr environment that you want to access.
{token}The access token generated through authentication.
{apikey}Your Developer Portal API key.

Response

A successful request returns information about the authenticated user.

{
  "data": {
    "name": "Shivangi Singh",
    "customerId": 66000000,
    "id": 66014640,
    "type": "PARTNER_ADMIN",
    "email": "shivangi.singh@sprinklr.com",
    "properties": {
      "_c_65b8a60cb6c96a319161e7c6": [
        "No"
      ],
      "_c_650c385a2b5a8629918ace0b": [
        "DEFAULT VALUE - ENGLISH"
      ]
    },
    "workspaceId": 66000002
  },
  "errors": []
}

Response Fields

FieldDescription
nameName of the authenticated user.
customerIdUnique identifier of the customer account.
idUnique identifier of the user.
typeUser role or account type.
emailEmail address associated with the account.
propertiesCustom user properties configured in the platform.
workspaceIdIdentifier of the workspace associated with the user.
errorsList of errors returned by the API. An empty array indicates a successful request.

Verify the Result

If the request succeeds, the API returns your user details in JSON format. This confirms that:

  • Your API key is valid.
  • Your access token is valid.
  • Your application can successfully communicate with Sprinklr APIs.

[!NOTE] Congratulations! You have successfully made your first API call and retrieved data from the Sprinklr platform.

Next Steps

Now that authentication is configured, you can:

  • Explore additional Sprinklr API endpoints.
  • Retrieve business data from your environment.
  • Build integrations and automation workflows.
  • Review API documentation for supported resources and operations.

Introduction

Accessible Workspace