POST api/list/pm/appointments

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

PmAppointmentsListFilterDataContract

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.
Types	The collection of types.	Collection of string	None.
BranchIds	The unique identifiers of the related branch resources.	Collection of integer	None.
AttendingNegotiatorIds	The unique identifiers of the related attending negotiator resources.	Collection of integer	None.
Statuses	The collection of statuses.	Collection of string	None.
ExcludeRoleStatuses	The collection of exclude role statuses.	Collection of string	None.
TenantRoleId	The unique identifier of the related tenant role resource.	integer	None.
Sort	The sort classification.	PmAppointmentsListSort	None.
GroupId	The unique identifier of the related group resource.	integer	None.
PropertyId	The unique identifier of the related property resource.	integer	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:54.2382339Z",
  "StartDateTo": "2026-07-23T10:35:54.2382339Z",
  "Types": [
    "sample string 1",
    "sample string 2"
  ],
  "BranchIds": [
    1,
    2
  ],
  "AttendingNegotiatorIds": [
    1,
    2
  ],
  "Statuses": [
    "sample string 1",
    "sample string 2"
  ],
  "ExcludeRoleStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "TenantRoleId": 1,
  "Sort": 0,
  "GroupId": 1,
  "PropertyId": 1,
  "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.

PagedCollectionDataContractOfAppointmentsListDataContract

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

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Address": "sample string 3",
      "AppointmentTypeSystemName": "sample string 4",
      "StartDate": "2026-07-23T10:35:54.2382339Z",
      "EndDate": "2026-07-23T10:35:54.2382339Z",
      "IsAllDay": true,
      "Attendees": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "AttendeeRole": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "AttendeeRole": "sample string 3"
        }
      ],
      "Negotiators": [
        {
          "Id": 1,
          "ContactName": "sample string 2",
          "JobTitle": "sample string 3"
        },
        {
          "Id": 1,
          "ContactName": "sample string 2",
          "JobTitle": "sample string 3"
        }
      ],
      "IsRecurring": true
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Address": "sample string 3",
      "AppointmentTypeSystemName": "sample string 4",
      "StartDate": "2026-07-23T10:35:54.2382339Z",
      "EndDate": "2026-07-23T10:35:54.2382339Z",
      "IsAllDay": true,
      "Attendees": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "AttendeeRole": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "AttendeeRole": "sample string 3"
        }
      ],
      "Negotiators": [
        {
          "Id": 1,
          "ContactName": "sample string 2",
          "JobTitle": "sample string 3"
        },
        {
          "Id": 1,
          "ContactName": "sample string 2",
          "JobTitle": "sample string 3"
        }
      ],
      "IsRecurring": true
    }
  ]
}