jellyfin-api/org.jellyfin.sdk.api.operations/PersonsApi/getPersons

getPersons

suspend fun getPersons(limit: Int? = null, searchTerm: String? = null, fields: Collection<<Error class: unknown class>>? = emptyList(), filters: Collection<<Error class: unknown class>>? = emptyList(), isFavorite: Boolean? = null, enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<<Error class: unknown class>>? = emptyList(), excludePersonTypes: Collection<String>? = emptyList(), personTypes: Collection<String>? = emptyList(), appearsInItemId: <Error class: unknown class>? = null, userId: <Error class: unknown class>? = null, enableImages: Boolean? = true): Response<<Error class: unknown class>>

Gets all persons.

Parameters

limit

Optional. The maximum number of records to return.

searchTerm

The search term.

fields

Optional. Specify additional fields of information to return in the output.

filters

Optional. Specify additional filters to apply.

isFavorite

Optional filter by items that are marked as favorite, or not. userId is required.

enableUserData

Optional, include user data.

imageTypeLimit

Optional, the max number of images to return, per image type.

enableImageTypes

Optional. The image types to include in the output.

excludePersonTypes

Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited.

personTypes

Optional. If specified results will be filtered to include only those containing the specified PersonType. Allows multiple, comma-delimited.

appearsInItemId

Optional. If specified, person results will be filtered on items related to said persons.

userId

User id.

enableImages

Optional, include image information in output.

suspend fun getPersons(request: <Error class: unknown class> = GetPersonsRequest()): Response<<Error class: unknown class>>

Gets all persons.

Parameters

request

The request parameters