Interface PersonsApiGetPersonsRequest

Request parameters for getPersons operation in PersonsApi.

Export

PersonsApiGetPersonsRequest

interface PersonsApiGetPersonsRequest {
    appearsInItemId?: string;
    enableImages?: boolean;
    enableImageTypes?: ImageType[];
    enableUserData?: boolean;
    excludePersonTypes?: string[];
    fields?: ItemFields[];
    filters?: ItemFilter[];
    imageTypeLimit?: number;
    isFavorite?: boolean;
    limit?: number;
    personTypes?: string[];
    searchTerm?: string;
    userId?: string;
}

Properties

appearsInItemId? enableImages? enableImageTypes? enableUserData? excludePersonTypes? fields? filters? imageTypeLimit? isFavorite? limit? personTypes? searchTerm? userId?

Properties

Optional ReadonlyappearsInItemId

appearsInItemId?: string

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

Memberof

PersonsApiGetPersons

Optional ReadonlyenableImages

enableImages?: boolean

Optional, include image information in output.

Memberof

PersonsApiGetPersons

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

PersonsApiGetPersons

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional, include user data.

Memberof

PersonsApiGetPersons

Optional ReadonlyexcludePersonTypes

excludePersonTypes?: string[]

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

Memberof

PersonsApiGetPersons

Optional Readonlyfields

fields?: ItemFields[]

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

Memberof

PersonsApiGetPersons

Optional Readonlyfilters

filters?: ItemFilter[]

Optional. Specify additional filters to apply.

Memberof

PersonsApiGetPersons

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

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

Memberof

PersonsApiGetPersons

Optional ReadonlyisFavorite

isFavorite?: boolean

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

Memberof

PersonsApiGetPersons

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

PersonsApiGetPersons

Optional ReadonlypersonTypes

personTypes?: string[]

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

Memberof

PersonsApiGetPersons

Optional ReadonlysearchTerm

searchTerm?: string

The search term.

Memberof

PersonsApiGetPersons

Optional ReadonlyuserId

userId?: string

User id.

Memberof

PersonsApiGetPersons

Settings

Member Visibility

On This Page

Properties