v1

latestOpenAPI 3.0.12026-07-134082641.7 MB
Years

Get years.

get/Years

Query parameters

startIndexinteger nullable

Skips over a given number of items within the results. Use for paging.

Skips over a given number of items within the results. Use for paging.

limitinteger nullable

Optional. The maximum number of records to return.

Optional. The maximum number of records to return.

sortOrderstring nullable

Sort Order - Ascending,Descending.

Sort Order - Ascending,Descending.

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 excluded based on item type. This allows multiple, comma delimited.

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

includeItemTypesstring[] nullable

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

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

mediaTypesstring[] nullable

Optional. Filter by MediaType. Allows multiple, comma delimited.

Optional. Filter by MediaType. Allows multiple, comma delimited.

sortBystring nullable

Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

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.

userIdstring uuid nullable

User Id.

User Id.

recursiveboolean

Search recursively.

Search recursively.

enableImagesboolean nullable

Optional. Include image information in output.

Optional. Include image information in output.

Response

Year query returned.

TotalRecordCountinteger

The total number of records available.

StartIndexinteger

The index of the first record in Items.