Skip to content

Fetch standard entity records by entityId/recordId, primary key, or primary key prefix.

Request

Security
bearerAuth and apiKeyAuth
Query
entityIdstring

Comma-separated list of entity IDs

recordIdstring

Comma-separated list of record IDs

entityTypestring

Entity type (required)

primaryKeystring

Primary key exact lookup flag

primaryKeyPrefixstring

Primary key prefix lookup flag

pageNumberstring

Page number for pagination

pageSizestring

Page size for pagination

curl -i -X GET \
  'https://developer.sprinklr.com/_mock/apis/sprinklr-v3/standardEntity/record?entityId=string&recordId=string&entityType=string&primaryKey=string&primaryKeyPrefix=string&pageNumber=string&pageSize=string' \
  -H 'Authorization: Bearer <YOUR_Token_HERE>' \
  -H 'Key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
Array [
serialVersionUIDobject

Unresolved type (staticfinallong)

canEditboolean
assetPermissionobject(AssetPermission)
idstring
entityIdstring
namestring
imagestring
detailstring
typestring
baseTypestring
valuesobject
processedValuesobject
importIdstring
globalUniquesobject

Unresolved type (transientSet)

lookupRecordsobject

Unresolved type (transientSet)

sharesobject(EntityShares)
scorecardobject(Scorecard)
tagsArray of strings
archivedboolean
entityMetadataobject(EntityMetadata)
langVsTranslatedFieldValuesobject
entityPriorityinteger, (int32)
createdByinteger, (int64)
permissionTypesobject

Unresolved type (transientList)

]
Response
[ { "serialVersionUID": {}, "canEdit": true, "assetPermission": { … }, "id": "string", "entityId": "string", "name": "string", "image": "string", "detail": "string", "type": "string", "baseType": "string", "values": { … }, "processedValues": { … }, "importId": "string", "globalUniques": {}, "lookupRecords": {}, "shares": { … }, "scorecard": { … }, "tags": [ … ], "archived": true, "entityMetadata": { … }, "langVsTranslatedFieldValues": { … }, "entityPriority": 0, "createdBy": 0, "permissionTypes": {} } ]