POST api/list/pm/tenants

Returns a list of Tenants 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 tenant list filter data contract supplied with the request.

PmTenantListFilterDataContract

Name	Description	Type	Additional 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.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "TeamGroupIds": [
    1,
    2
  ],
  "BranchIds": [
    1,
    2
  ],
  "IdReceived": true,
  "RightToRentStatus": [
    "sample string 1",
    "sample string 2"
  ],
  "ProofOfIdStatus": [
    "sample string 1",
    "sample string 2"
  ],
  "TenantReferenceStatus": [
    "sample string 1",
    "sample string 2"
  ],
  "ProofOfAddressStatus": [
    "sample string 1",
    "sample string 2"
  ],
  "ProofOfSanctionsStatus": [
    "sample string 1",
    "sample string 2"
  ],
  "RightToRentExpiryFrom": "2026-08-04T22:23:35.1378083Z",
  "RightToRentExpiryTo": "2026-08-04T22:23:35.1378083Z",
  "IncludeArchived": true,
  "IncludeActiveTenancies": true,
  "Sort": 0,
  "PageSize": 1,
  "PageNumber": 1,
  "Term": "sample string 2",
  "OrderByDescending": true,
  "Name": "sample string 3"
}

Response Information

Resource Description

The response returned after the operation completes.

PagedCollectionDataContractOfTenantListDataContract

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 TenantListDataContract	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "GroupId": 1,
      "GroupName": "sample string 2",
      "PrimaryContactName": "sample string 3",
      "Email": "sample string 4",
      "EmailMarketingStatus": "sample string 5",
      "Telephone": "sample string 6",
      "TelephoneMarketingStatus": "sample string 7",
      "Address": "sample string 8",
      "GroupMembers": 9,
      "IdReceived": 10,
      "RightToRentReceived": 11,
      "TenantReferences": 12,
      "TenantReferenceStatus": "sample string 13",
      "ActiveTenanciesCount": 14,
      "RightToRentStatus": 15,
      "IdStatus": 16,
      "ProofOfAddressReceived": 17,
      "ProofOfAddressStatus": 18,
      "ProofOfSanctionsReceived": 19,
      "ProofOfSanctionsStatus": 20
    },
    {
      "GroupId": 1,
      "GroupName": "sample string 2",
      "PrimaryContactName": "sample string 3",
      "Email": "sample string 4",
      "EmailMarketingStatus": "sample string 5",
      "Telephone": "sample string 6",
      "TelephoneMarketingStatus": "sample string 7",
      "Address": "sample string 8",
      "GroupMembers": 9,
      "IdReceived": 10,
      "RightToRentReceived": 11,
      "TenantReferences": 12,
      "TenantReferenceStatus": "sample string 13",
      "ActiveTenanciesCount": 14,
      "RightToRentStatus": 15,
      "IdStatus": 16,
      "ProofOfAddressReceived": 17,
      "ProofOfAddressStatus": 18,
      "ProofOfSanctionsReceived": 19,
      "ProofOfSanctionsStatus": 20
    }
  ]
}