Skip to main content
View as Markdown

Get a User Profile - User Profile

Get a User Profile​

8.1 Get by ID​

curl -X POST "$KALTURA_USER_PROFILE_URL/user-profile/get" \
-H "Authorization: Bearer $KALTURA_KS" \
-H "Content-Type: application/json" \
-d "{\"id\": \"$PROFILE_ID\"}"
FieldTypeRequiredDescription
idstringYesUser profile ID

Response: Full user profile object. Returns USER_PROFILE_NOT_FOUND if the ID does not exist or the profile is deleted.

{
"id": "6620a1b2c3d4e5f6a7b8c9d0",
"partnerId": 123456,
"appGuid": "app-guid-from-registry",
"userId": "user@example.com",
"status": "enabled",
"profileData": {
"name": "Jane Doe",
"company": "Acme Corp"
},
"eventData": {
"regOrigin": "registration",
"attendanceStatus": "registered",
"isRegistered": false,
"statusUpdateTime": "2025-06-15T10:30:00.000Z"
},
"appData": {},
"createdAt": "2025-06-15T10:30:00.000Z",
"updatedAt": "2025-06-15T10:30:00.000Z",
"objectType": "UserProfile"
}

8.2 Get by Filter​

Returns the first matching profile (internally calls list with limit: 1). Use this to look up a user within a specific app.

FieldTypeRequiredDescription
appGuidInstring[]NoFilter by app GUIDs
userIdInstring[]NoFilter by user IDs (email addresses matched case-insensitively)
statusstringNoenabled or disabled
attendanceStatusstringNoFilter by current attendance status

All filter fields from section 10.1 are supported. Returns null if no match is found.

curl -X POST "$KALTURA_USER_PROFILE_URL/user-profile/getByFilter" \
-H "Authorization: Bearer $KALTURA_KS" \
-H "Content-Type: application/json" \
-d "{
\"appGuidIn\": [\"$APP_GUID\"],
\"userIdIn\": [\"user@example.com\"],
\"status\": \"enabled\"
}"