Sign in

v1

latestOpenAPI 3.0.12026-07-134082641.7 MB
Items

Gets items based on a query.

get/Users/{userId}/Items/Resume

Path parameters

userIdstring uuid required

The user id.

The user id.

Query parameters

startIndexinteger nullable

The start index.

The start index.

limitinteger nullable

The item limit.

The item limit.

searchTermstring nullable

The search term.

The 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. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.

Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.

mediaTypesstring[] nullable

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

Optional. Filter by MediaType. 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.

excludeItemTypesstring[] 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.

includeItemTypesstring[] nullable

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

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

enableTotalRecordCountboolean

Optional. Enable the total record count.

Optional. Enable the total record count.

enableImagesboolean nullable

Optional. Include image information in output.

Optional. Include image information in output.

Response

Items returned.

TotalRecordCountinteger

The total number of records available.

StartIndexinteger

The index of the first record in Items.