@jellyfin/sdk
    Preparing search index...

    Interface PersonApiGetPersonsRequest

    Request parameters for getPersons operation in PersonApi.

    interface PersonApiGetPersonsRequest {
        appearsInItemId?: string;
        enableImages?: boolean;
        enableImageTypes?: ImageType[];
        enableUserData?: boolean;
        excludePersonTypes?: string[];
        fields?: ItemFields[];
        filters?: ItemFilter[];
        imageTypeLimit?: number;
        isFavorite?: boolean;
        limit?: number;
        nameLessThan?: string;
        nameStartsWith?: string;
        nameStartsWithOrGreater?: string;
        parentId?: string;
        personTypes?: string[];
        searchTerm?: string;
        startIndex?: number;
        userId?: string;
    }
    Index
    appearsInItemId? enableImages? enableImageTypes? enableUserData? excludePersonTypes? fields? filters? imageTypeLimit? isFavorite? limit? nameLessThan? nameStartsWith? nameStartsWithOrGreater? parentId? personTypes? searchTerm? startIndex? userId?
    appearsInItemId?: string

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

    enableImages?: boolean

    Optional, include image information in output.

    enableImageTypes?: ImageType[]

    Optional. The image types to include in the output.

    enableUserData?: boolean

    Optional, include user data.

    excludePersonTypes?: string[]

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

    fields?: ItemFields[]

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

    filters?: ItemFilter[]

    Optional. Specify additional filters to apply.

    imageTypeLimit?: number

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

    isFavorite?: boolean

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

    limit?: number

    Optional. The maximum number of records to return.

    nameLessThan?: string

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

    nameStartsWith?: string

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

    nameStartsWithOrGreater?: string

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

    parentId?: string

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

    personTypes?: string[]

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

    searchTerm?: string

    The search term.

    startIndex?: number

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

    userId?: string

    User id.

    Settings
    Member Visibility

    On This Page
    Properties