@jellyfin/sdk
    Preparing search index...

    Interface ArtistsApiGetArtistsRequest

    Request parameters for getArtists operation in ArtistsApi.

    ArtistsApiGetArtistsRequest

    interface ArtistsApiGetArtistsRequest {
        enableImages?: boolean;
        enableImageTypes?: ImageType[];
        enableTotalRecordCount?: boolean;
        enableUserData?: boolean;
        excludeItemTypes?: BaseItemKind[];
        fields?: ItemFields[];
        filters?: ItemFilter[];
        genreIds?: string[];
        genres?: string[];
        imageTypeLimit?: number;
        includeItemTypes?: BaseItemKind[];
        isFavorite?: boolean;
        limit?: number;
        mediaTypes?: MediaType[];
        minCommunityRating?: number;
        nameLessThan?: string;
        nameStartsWith?: string;
        nameStartsWithOrGreater?: string;
        officialRatings?: string[];
        parentId?: string;
        person?: string;
        personIds?: string[];
        personTypes?: string[];
        searchTerm?: string;
        sortBy?: ItemSortBy[];
        sortOrder?: SortOrder[];
        startIndex?: number;
        studioIds?: string[];
        studios?: string[];
        tags?: string[];
        userId?: string;
        years?: number[];
    }
    Index

    Properties

    enableImages? enableImageTypes? enableTotalRecordCount? enableUserData? excludeItemTypes? fields? filters? genreIds? genres? imageTypeLimit? includeItemTypes? isFavorite? limit? mediaTypes? minCommunityRating? nameLessThan? nameStartsWith? nameStartsWithOrGreater? officialRatings? parentId? person? personIds? personTypes? searchTerm? sortBy? sortOrder? startIndex? studioIds? studios? tags? userId? years?

    Properties

    enableImages?: boolean

    Optional, include image information in output.

    ArtistsApiGetArtists

    enableImageTypes?: ImageType[]

    Optional. The image types to include in the output.

    ArtistsApiGetArtists

    enableTotalRecordCount?: boolean

    Total record count.

    ArtistsApiGetArtists

    enableUserData?: boolean

    Optional, include user data.

    ArtistsApiGetArtists

    excludeItemTypes?: BaseItemKind[]

    Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.

    ArtistsApiGetArtists

    fields?: ItemFields[]

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

    ArtistsApiGetArtists

    filters?: ItemFilter[]

    Optional. Specify additional filters to apply.

    ArtistsApiGetArtists

    genreIds?: string[]

    Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.

    ArtistsApiGetArtists

    genres?: string[]

    Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.

    ArtistsApiGetArtists

    imageTypeLimit?: number

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

    ArtistsApiGetArtists

    includeItemTypes?: BaseItemKind[]

    Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.

    ArtistsApiGetArtists

    isFavorite?: boolean

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

    ArtistsApiGetArtists

    limit?: number

    Optional. The maximum number of records to return.

    ArtistsApiGetArtists

    mediaTypes?: MediaType[]

    Optional filter by MediaType. Allows multiple, comma delimited.

    ArtistsApiGetArtists

    minCommunityRating?: number

    Optional filter by minimum community rating.

    ArtistsApiGetArtists

    nameLessThan?: string

    Optional filter by items whose name is equally or lesser than a given input string.

    ArtistsApiGetArtists

    nameStartsWith?: string

    Optional filter by items whose name is sorted equally than a given input string.

    ArtistsApiGetArtists

    nameStartsWithOrGreater?: string

    Optional filter by items whose name is sorted equally or greater than a given input string.

    ArtistsApiGetArtists

    officialRatings?: string[]

    Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.

    ArtistsApiGetArtists

    parentId?: string

    Specify this to localize the search to a specific item or folder. Omit to use the root.

    ArtistsApiGetArtists

    person?: string

    Optional. If specified, results will be filtered to include only those containing the specified person.

    ArtistsApiGetArtists

    personIds?: string[]

    Optional. If specified, results will be filtered to include only those containing the specified person ids.

    ArtistsApiGetArtists

    personTypes?: string[]

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

    ArtistsApiGetArtists

    searchTerm?: string

    Optional. Search term.

    ArtistsApiGetArtists

    sortBy?: ItemSortBy[]

    Optional. Specify one or more sort orders, comma delimited.

    ArtistsApiGetArtists

    sortOrder?: SortOrder[]

    Sort Order - Ascending,Descending.

    ArtistsApiGetArtists

    startIndex?: number

    Optional. The record index to start at. All items with a lower index will be dropped from the results.

    ArtistsApiGetArtists

    studioIds?: string[]

    Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.

    ArtistsApiGetArtists

    studios?: string[]

    Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.

    ArtistsApiGetArtists

    tags?: string[]

    Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.

    ArtistsApiGetArtists

    userId?: string

    User id.

    ArtistsApiGetArtists

    years?: number[]

    Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.

    ArtistsApiGetArtists

    Settings

    Member Visibility

    On This Page

    Properties