v1

latestOpenAPI 3.0.12026-07-134082641.7 MB
Studios

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

get/Studios

Query parameters

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.

isFavoriteboolean nullable

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

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

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.

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

Studios returned.

TotalRecordCountinteger

The total number of records available.

StartIndexinteger

The index of the first record in Items.