getPersons

suspend fun getPersons(startIndex: Int? = null, limit: Int? = null, searchTerm: String? = null, nameStartsWith: String? = null, nameLessThan: String? = null, nameStartsWithOrGreater: String? = null, fields: Collection<ItemFields>? = emptyList(), filters: Collection<ItemFilter>? = emptyList(), isFavorite: Boolean? = null, enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = emptyList(), excludePersonTypes: Collection<String>? = emptyList(), personTypes: Collection<String>? = emptyList(), parentId: UUID? = null, appearsInItemId: UUID? = null, userId: UUID? = null, enableImages: Boolean? = true): Response<BaseItemDtoQueryResult>

Gets all persons.

startIndex

Optional. All items with a lower index will be dropped from the response.

limit

Optional. The maximum number of records to return.

searchTerm

The search term.

nameStartsWith

Optional. Filter by items whose name starts with the given input string.

nameLessThan

Optional. Filter by items whose name will appear before this value when sorted alphabetically.

nameStartsWithOrGreater

Optional. Filter by items whose name will appear after this value when sorted alphabetically.

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.

parentId

Optional. Specify this to localize the search to a specific library. Omit to use the root.

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.

Gets all persons.

request

The request parameters