POST api/appointment/freebusy

Returns Free/Busy information regarding multiple people. Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The people free busy query data contract supplied with the request.

PeopleFreeBusyQueryDataContract

Name	Description	Type	Additional information
Scope	The scope value.	TimeRangeDataContract	None.
PersonIds	The unique identifiers of the related person resources.	Collection of integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Scope": {
    "Start": "2026-07-23T08:20:15.3757974Z",
    "End": "2026-07-23T08:20:15.3757974Z"
  },
  "PersonIds": [
    1,
    2
  ]
}

Response Information

Resource Description

A list of free/busy information, by person.

Collection of PeopleFreeBusyQueryResponseDataContract

Name	Description	Type	Additional information
PersonId	The unique identifier of the related person resource.	integer	None.
BusyTimeRanges	The collection of busy time ranges.	Collection of TimeRangeDataContract	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PersonId": 1,
    "BusyTimeRanges": [
      {
        "Start": "2026-07-23T08:20:15.3757974Z",
        "End": "2026-07-23T08:20:15.3757974Z"
      },
      {
        "Start": "2026-07-23T08:20:15.3757974Z",
        "End": "2026-07-23T08:20:15.3757974Z"
      }
    ]
  },
  {
    "PersonId": 1,
    "BusyTimeRanges": [
      {
        "Start": "2026-07-23T08:20:15.3757974Z",
        "End": "2026-07-23T08:20:15.3757974Z"
      },
      {
        "Start": "2026-07-23T08:20:15.3757974Z",
        "End": "2026-07-23T08:20:15.3757974Z"
      }
    ]
  }
]