v1

latestOpenAPI 3.0.12026-07-134082641.7 MB
Persons

Gets all persons.

get/Persons

Query parameters

limitinteger nullable

Optional. The maximum number of records to return.

Optional. The maximum number of records to return.

searchTermstring nullable

The search term.

The search term.

fieldsItemFields[] nullable

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

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

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. userId is required.

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

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.

excludePersonTypesstring[] nullable

Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited.

Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited.

personTypesstring[] nullable

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

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

appearsInItemIdstring uuid nullable

Optional. If specified, person results will be filtered on items related to said persons.

Optional. If specified, person results will be filtered on items related to said persons.

userIdstring uuid nullable

User id.

User id.

enableImagesboolean nullable

Optional, include image information in output.

Optional, include image information in output.

Response

Persons returned.

TotalRecordCountinteger

The total number of records available.

StartIndexinteger

The index of the first record in Items.