GET api/account/{groupId}/tenancies?withUnpaidTransactions={withUnpaidTransactions}

Get a list of tenancies for a group Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupId

Group id

integer

Required

withUnpaidTransactions

The with unpaid transactions value supplied with the request.

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

Collection of RelatedPropertyAccountDataContract
NameDescriptionTypeAdditional information
Key

The key value.

integer

None.

Value

The value represented by this field.

string

None.

PropertyId

The unique identifier of the related property resource.

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Key": 1,
    "Value": "sample string 2",
    "PropertyId": 1
  },
  {
    "Key": 1,
    "Value": "sample string 2",
    "PropertyId": 1
  }
]