NameDescriptionTypeAdditional information
TeamGroupIds

The unique identifiers of the related team group resources.

Collection of integer

None.

BranchIds

The unique identifiers of the related branch resources.

Collection of integer

None.

IdReceived

Indicates whether id received is true.

boolean

None.

RightToRentStatus

The collection of right to rent status.

Collection of string

None.

ProofOfIdStatus

The collection of proof of id status.

Collection of string

None.

TenantReferenceStatus

The collection of tenant reference status.

Collection of string

None.

ProofOfAddressStatus

The collection of proof of address status.

Collection of string

None.

ProofOfSanctionsStatus

The collection of proof of sanctions status.

Collection of string

None.

RightToRentExpiryFrom

The right to rent expiry from, expressed as a date and time.

date

None.

RightToRentExpiryTo

The right to rent expiry to, expressed as a date and time.

date

None.

IncludeArchived

Indicates whether include archived is true.

boolean

None.

IncludeActiveTenancies

Indicates whether include active tenancies is true.

boolean

None.

Sort

The sort classification.

PMGroupSort

None.

PageSize

The page size value.

integer

None.

PageNumber

The page number value.

integer

None.

Term

The term value.

string

None.

OrderByDescending

Indicates whether order by descending is true.

boolean

None.

Name

The name value.

string

None.