POST api/list/pm/tenancy

Returns a list of Tenancies in PM Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The pm tenancy list filter data contract supplied with the request.

PmTenancyListFilterDataContract

Name	Description	Type	Additional information
StartDateFrom	The start date from, expressed as a date and time.	date	None.
StartDateTo	The start date to, expressed as a date and time.	date	None.
EndDateFrom	The end date from, expressed as a date and time.	date	None.
EndDateTo	The end date to, expressed as a date and time.	date	None.
TeamGroupIds	The unique identifiers of the related team group resources.	Collection of integer	None.
TenancyStatuses	The collection of tenancy statuses.	Collection of string	None.
TermTypes	The collection of term types.	Collection of string	None.
BranchIds	The unique identifiers of the related branch resources.	Collection of integer	None.
NoticeFromDate	The notice from date, expressed as a date and time.	date	None.
NoticeToDate	The notice to date, expressed as a date and time.	date	None.
Sort	The sort classification.	PmTenancyListSort	None.
ServiceLevels	The collection of service levels.	Collection of string	None.
RentDuePeriod	The rent due period classification.	RentDueType	None.
TenancyRoleIds	The unique identifiers of the related tenancy role resources.	Collection of integer	None.
HasPendingPetRequests	Indicates whether this item has pending pet requests.	boolean	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.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "StartDateFrom": "2026-07-23T10:35:53.8153382Z",
  "StartDateTo": "2026-07-23T10:35:53.8153382Z",
  "EndDateFrom": "2026-07-23T10:35:53.8153382Z",
  "EndDateTo": "2026-07-23T10:35:53.8153382Z",
  "TeamGroupIds": [
    1,
    2
  ],
  "TenancyStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "TermTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "BranchIds": [
    1,
    2
  ],
  "NoticeFromDate": "2026-07-23T10:35:53.8153382Z",
  "NoticeToDate": "2026-07-23T10:35:53.8153382Z",
  "Sort": 0,
  "ServiceLevels": [
    "sample string 1",
    "sample string 2"
  ],
  "RentDuePeriod": 0,
  "TenancyRoleIds": [
    1,
    1
  ],
  "HasPendingPetRequests": true,
  "PageSize": 1,
  "PageNumber": 1,
  "Term": "sample string 1",
  "OrderByDescending": true,
  "Name": "sample string 2"
}

Response Information

Resource Description

The response returned after the operation completes.

PagedCollectionDataContractOfTenancySummaryListDataContract

Name	Description	Type	Additional information
TotalCount	The total count value.	integer	None.
CurrentCount	The current count value.	integer	None.
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.
Collection	The collection of collection.	Collection of TenancySummaryListDataContract	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "Id": 1,
      "PropertyLettingRoleId": 2,
      "ServiceLevelName": "sample string 3",
      "Address": "sample string 4",
      "TenantPrimaryContactName": "sample string 5",
      "TenantGroupId": 6,
      "TenantPrimaryEmail": "sample string 7",
      "TenantPrimaryTelephone": "sample string 8",
      "LandlordPrimaryContactName": "sample string 9",
      "LandlordGroupId": 10,
      "LandlordPrimaryEmail": "sample string 11",
      "LandlordPrimaryTelephone": "sample string 12",
      "TenancyType": "sample string 13",
      "TenancyStatus": "sample string 14",
      "TenancyEndDate": "2026-07-23T10:35:53.9872158Z",
      "RentAmount": "sample string 15",
      "IssueNoticeDate": "2026-07-23T10:35:53.9872158Z"
    },
    {
      "Id": 1,
      "PropertyLettingRoleId": 2,
      "ServiceLevelName": "sample string 3",
      "Address": "sample string 4",
      "TenantPrimaryContactName": "sample string 5",
      "TenantGroupId": 6,
      "TenantPrimaryEmail": "sample string 7",
      "TenantPrimaryTelephone": "sample string 8",
      "LandlordPrimaryContactName": "sample string 9",
      "LandlordGroupId": 10,
      "LandlordPrimaryEmail": "sample string 11",
      "LandlordPrimaryTelephone": "sample string 12",
      "TenancyType": "sample string 13",
      "TenancyStatus": "sample string 14",
      "TenancyEndDate": "2026-07-23T10:35:53.9872158Z",
      "RentAmount": "sample string 15",
      "IssueNoticeDate": "2026-07-23T10:35:53.9872158Z"
    }
  ]
}