Kaltura API DocumentationcategoryUser.list

List all categories

Try it out
post https://www.kaltura.com/api_v3/service/categoryuser/action/list

Request Parameters

body:object
object
filter:object:KalturaCategoryUserFilter
categoryDirectMembers:boolean

Return the list of categoryUser that are not inherited from parent category - only the direct categoryUsers.

freeText:string

Free text search on user id or screen name

orderBy:string
Enum: CREATED_AT_ASC [+createdAt], UPDATED_AT_ASC [+updatedAt], CREATED_AT_DESC [-createdAt], UPDATED_AT_DESC [-updatedAt]
relatedGroupsByUserId:string

Return a list of categoryUser that related to the userId in this field by groups

KalturaCategoryUserFilter must also match all of:
object:KalturaCategoryUserBaseFilter
pager:object:KalturaFilterPager

The KalturaFilterPager object enables paging management to be applied upon service list actions.

KalturaFilterPager must also match all of:
object:KalturaPager

Response

Success

object:KalturaCategoryUserListResponse
objects:array[object:KalturaCategoryUser]
object:KalturaCategoryUser
categoryFullIds:string

readOnly

The full ids of the Category

categoryId:integer

insertOnly

createdAt:integer

readOnly

CategoryUser creation date as Unix timestamp (In seconds)

partnerId:integer

readOnly

Partner id

permissionLevel:integer
Enum: MANAGER [0], MODERATOR [1], CONTRIBUTOR [2], MEMBER [3], NONE [4]

Enum Type: KalturaCategoryUserPermissionLevel

Permission level

permissionNames:string

Set of category-related permissions for the current category user.

status:integer
Enum: ACTIVE [1], PENDING [2], NOT_ACTIVE [3], DELETED [4]

readOnly

Enum Type: KalturaCategoryUserStatus

Status

updateMethod:integer
Enum: MANUAL [0], AUTOMATIC [1]

Enum Type: KalturaUpdateMethodType

Update method can be either manual or automatic to distinguish between manual operations (for example in KMC) on automatic - using bulk upload

updatedAt:integer

readOnly

CategoryUser update date as Unix timestamp (In seconds)

userId:string

insertOnly

User id

KalturaCategoryUserListResponse must also match all of:
object:KalturaListResponse