v1

latestOpenAPI 3.0.12026-07-134082641.7 MB
Artists

Gets all album artists from a given item, folder, or the entire library.

get/Artists/AlbumArtists

Query parameters

minCommunityRatingnumber double nullable

Optional filter by minimum community rating.

Optional filter by minimum community rating.

startIndexinteger nullable

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

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

limitinteger nullable

Optional. The maximum number of records to return.

Optional. The maximum number of records to return.

searchTermstring nullable

Optional. Search term.

Optional. Search term.

parentIdstring uuid nullable

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

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

fieldsItemFields[] nullable

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

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

excludeItemTypesstring[] nullable

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

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

includeItemTypesstring[] nullable

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

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

filtersItemFilter[] nullable

Optional. Specify additional filters to apply.

Optional. Specify additional filters to apply.

isFavoriteboolean nullable

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

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

mediaTypesstring[] nullable

Optional filter by MediaType. Allows multiple, comma delimited.

Optional filter by MediaType. Allows multiple, comma delimited.

genresstring[] nullable

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

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

genreIdsstring[] nullable

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

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

officialRatingsstring[] nullable

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

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

tagsstring[] nullable

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

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

yearsinteger[] nullable

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

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

enableUserDataboolean nullable

Optional, include user data.

Optional, include user data.

imageTypeLimitinteger nullable

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

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

enableImageTypesImageType[] nullable

Optional. The image types to include in the output.

Optional. The image types to include in the output.

personstring nullable

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

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

personIdsstring[] nullable

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

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

personTypesstring[] nullable

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

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

studiosstring[] nullable

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

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

studioIdsstring[] nullable

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

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

userIdstring uuid nullable

User id.

User id.

nameStartsWithOrGreaterstring nullable

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

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

nameStartsWithstring nullable

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

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

nameLessThanstring nullable

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

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

enableImagesboolean nullable

Optional, include image information in output.

Optional, include image information in output.

enableTotalRecordCountboolean

Total record count.

Total record count.

Response

Album artists returned.

TotalRecordCountinteger

The total number of records available.

StartIndexinteger

The index of the first record in Items.