Skip to main content
View as Markdown

KalturaCategory Object - Content Management

KalturaCategory Object​

Every category in a Kaltura partner account is a KalturaCategory:

FieldTypeDescription
idintegerAuto-generated category ID (read-only)
namestringCategory display name
parentIdintegerParent category ID (0 for root-level categories)
fullNamestringFull path from root (e.g., "Media>Training>Onboarding") (read-only)
fullIdsstringFull ID path from root (e.g., "12>45>78") (read-only)
referenceIdstringExternal reference identifier
descriptionstringCategory description
tagsstringComma-separated tags
depthintegerDepth in the hierarchy (0 for root) (read-only)
entriesCountintegerNumber of entries assigned (read-only)
directEntriesCountintegerEntries assigned directly (not via subcategories) (read-only)
directSubCategoriesCountintegerNumber of immediate child categories (read-only)
membersCountintegerNumber of category members (read-only)
statusintegerCategory status (see below)
privacyintegerPrivacy level (see below)
privacyContextstringPrivacy context label for entitlement
privacyContextsstringComma-separated list of privacy context labels
appearInListintegerWho can see this category in listings (see below)
contributionPolicyintegerWho can assign content (see below)
inheritanceTypeinteger1 = INHERIT from parent, 2 = MANUAL
userJoinPolicyintegerHow users can join (see below)
defaultPermissionLevelintegerDefault permission for new members
moderationinteger1 = entries require approval before activation
ownerstringOwner user ID
partnerIdintegerPartner ID (read-only)
createdAtintegerUnix timestamp (read-only)
updatedAtintegerUnix timestamp (read-only)
objectTypestringAlways "KalturaCategory" (read-only)

Category Status Values​

ValueNameDescription
1UPDATINGCategory is being updated (tree restructuring in progress)
2ACTIVENormal active category
3DELETEDSoft-deleted
4PURGEDPermanently removed

Privacy Levels (KalturaPrivacyType)​

ValueNameDescription
1ALLContent is visible to everyone with access to the application
2AUTHENTICATED_USERSContent is visible to authenticated users only (KS with userId)
3MEMBERS_ONLYContent is visible only to category members and content owners

Contribution Policy (KalturaContributionPolicyType)​

ValueNameDescription
1ALLAny user can assign content to this category
2MEMBERS_WITH_CONTRIBUTION_PERMISSIONOnly members with CONTRIBUTOR permission or higher

Appear In List​

ValueNameDescription
1PARTNER_ONLYVisible to all partner users
3CATEGORY_MEMBERS_ONLYVisible only to category members

User Join Policy (KalturaUserJoinPolicyType)​

ValueNameDescription
1AUTO_JOINUsers can add themselves to the category
2REQUEST_TO_JOINUsers can request to join; requires moderator approval
3NOT_ALLOWEDBy invitation only; users cannot request to join