Skip to content

Profile

Manage universal customer profiles. Supports fetching by profile ID or channel type and channel ID, paginated channel type and user name search, creating, full and partial updates, upsert, and bulk create, update, patch, and upsert jobs with status polling.

Operations

Fetch Profile by Id or ChannelType, ChannelId. Supports bulk fetch. OR paginated channelType + userName search.

Request

Security
bearerAuth and apiKeyAuth
Query
idstring

Comma-separated list of id

channelTypeChannelIdstring

Comma-separated list of channelTypeChannelId

pageNumberstring

Page number for paginated search (0-based)

pageSizestring

Page size for paginated search

channelTypestring

Channel type for paginated search

usernamestring

User name for paginated search

curl -i -X GET \
  'https://dev-staging.sprinklr.com/_mock/apis/sprinklr-v3/profile?id=string&channelTypeChannelId=string&pageNumber=string&pageSize=string&channelType=string&username=string' \
  -H 'Authorization: Bearer <YOUR_Token_HERE>' \
  -H 'Key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
Array [
idstring

Unique identifier of the unified profile

contactobject(ContactInfo)

Contact Information of the profile.

demographicsobject(Demographics)

Demographic details of the profile.

worksArray of objects(Work)

Work history of the profile.

profilesArray of objects(Profile)

List of social identities linked to the profile.

profileWorkflowobject(ProfileWorkflow)

List of social identities linked to the profile.

createdTimeinteger, (int64)

Created time of the profile in sprinklr.

modifiedTimeinteger, (int64)

Last modified time of the profile in sprinklr.

organizationsArray of objects(Organization)

Organizations of the profile

certificatesArray of objects(Certificate)

Certificates of the profile

recommendationsArray of objects(ProfileRecommendation)

Recommendations of the profile

educationsArray of objects(Education)

Educations of the profile

languagesArray of objects(Language)

Languages of the profile

skillsArray of objects(Skill)

Skills of the profile

coursesArray of objects(Course)

Courses of the profile

honorsArray of objects(Honors)

Honors of the profile

patentsArray of objects(Patent)

Patents of the profile

projectsArray of objects(Project)

Projects of the profile

publicationsArray of objects(Publication)

Publications of the profile

testScoresArray of objects(TestScore)

Test scores of the profile

voluntaryExpArray of objects(VoluntaryExperience)

Voluntary Experience of the profile

operatingHoursobject(OperatingHours)

Operating Hours of the profile

customPropertiesMetadataArray of objects(CustomPropertyWithMetadata)

Custom Property details

restrictedboolean

Profile Masked Flag

]
Response
[
  {
    "id": "string",
    "contact": { … },
    "demographics": { … },
    "works": [ … ],
    "profiles": [ … ],
    "profileWorkflow": { … },
    "createdTime": 0,
    "modifiedTime": 0,
    "organizations": [ … ],
    "certificates": [ … ],
    "recommendations": [ … ],
    "educations": [ … ],
    "languages": [ … ],
    "skills": [ … ],
    "courses": [ … ],
    "honors": [ … ],
    "patents": [ … ],
    "projects": [ … ],
    "publications": [ … ],
    "testScores": [ … ],
    "voluntaryExp": [ … ],
    "operatingHours": { … },
    "customPropertiesMetadata": [ … ],
    "restricted": true
  }
]