Skip to content

Lookup

Resolve identifiers and reference values used across API v3. Supports a generic lookup request and lookups by dimensions.

Operations

Generic lookup API

Request

Security
bearerAuth and apiKeyAuth
Bodyapplication/jsonrequired
lookupTypestring
keysArray of strings
extraParamsobject
curl -i -X POST \
  https://developer.sprinklr.com/_mock/apis/sprinklr-v3/lookup \
  -H 'Authorization: Bearer <YOUR_Token_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Key: YOUR_API_KEY_HERE' \
  -d '{
    "lookupType": "string",
    "keys": [
      "string"
    ],
    "extraParams": {}
  }'

Responses

Success

Bodyapplication/json
dataobject
errorsArray of objects(Error)
metadataobject(ResponseMetadata)
Response
{
  "data": {},
  "errors": [
    { … }
  ],
  "metadata": {}
}