POST api/list/appointments
Get Appointment Event List. 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 appointment event filter data contract supplied with the request.
AppointmentEventFilterDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| From |
The from, expressed as a date and time. |
date |
None. |
| To |
The to, expressed as a date and time. |
date |
None. |
| EventCategories |
The collection of event categories. |
Collection of EnumDataContract |
None. |
| NegotiatorIds |
The unique identifiers of the related negotiator resources. |
Collection of integer |
None. |
| ExcludedTypes |
The collection of excluded types. |
Collection of EnumDataContract |
None. |
| RoleIds |
The unique identifiers of the related role resources. |
Collection of integer |
None. |
| GroupId |
The unique identifier of the related group resource. |
integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"From": "2026-07-23T10:33:41.3735456Z",
"To": "2026-07-23T10:33:41.3735456Z",
"EventCategories": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"NegotiatorIds": [
1,
1
],
"ExcludedTypes": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"RoleIds": [
1,
1
],
"GroupId": 1
}
Response Information
Resource Description
The response returned after the operation completes.
PagedCollectionDataContractOfAppointmentEventDataContract| 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 AppointmentEventDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalCount": 1,
"CurrentCount": 2,
"PageSize": 1,
"PageNumber": 1,
"Collection": [
{
"Id": 1,
"AllDayEvent": true,
"BranchId": 3,
"Name": "sample string 4",
"Description": "sample string 5",
"StartDate": "2026-07-23T10:33:41.3735456Z",
"EndDate": "2026-07-23T10:33:41.3735456Z",
"DateTime": "2026-07-23T10:33:41.3735456Z",
"MeetingPlace": {
"AddressId": 1
},
"AttendingGroups": [
{
"EventId": 1,
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"AttendingPeople": [
{
"Id": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3"
},
{
"Id": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3"
}
],
"Group": {
"Id": 1,
"Name": "sample string 2",
"OwningTeamId": 3,
"OwningTeamName": "sample string 4",
"BranchId": 5,
"Description": "sample string 6",
"Notes": "sample string 7",
"GroupType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Grade": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FinancialStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"PrimaryGroupMember": {
"Id": 1,
"Title": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"ContactName": "sample string 5",
"PrimaryEmail": {
"Value": "sample string 1",
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"AllowContact": true
},
"PrimaryTelephone": {
"Value": "sample string 1",
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"AllowContact": true
}
},
"BranchOwningTeam": "sample string 8"
}
},
{
"EventId": 1,
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"AttendingPeople": [
{
"Id": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3"
},
{
"Id": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3"
}
],
"Group": {
"Id": 1,
"Name": "sample string 2",
"OwningTeamId": 3,
"OwningTeamName": "sample string 4",
"BranchId": 5,
"Description": "sample string 6",
"Notes": "sample string 7",
"GroupType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Grade": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FinancialStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"PrimaryGroupMember": {
"Id": 1,
"Title": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"ContactName": "sample string 5",
"PrimaryEmail": {
"Value": "sample string 1",
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"AllowContact": true
},
"PrimaryTelephone": {
"Value": "sample string 1",
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"AllowContact": true
}
},
"BranchOwningTeam": "sample string 8"
}
}
],
"Negotiators": [
{
"Id": 1,
"EventId": 2,
"ContactName": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5"
},
{
"Id": 1,
"EventId": 2,
"ContactName": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5"
}
],
"Properties": [
{
"Id": 1,
"Address": {
"Id": 1,
"Number": "sample string 2",
"BuildingName": "sample string 3",
"OrganizationName": "sample string 4",
"Street": "sample string 5",
"Town": "sample string 6",
"Locality": "sample string 7",
"County": "sample string 8",
"Postcode": "sample string 9",
"LatitudeLongitude": "sample string 10"
}
},
{
"Id": 1,
"Address": {
"Id": 1,
"Number": "sample string 2",
"BuildingName": "sample string 3",
"OrganizationName": "sample string 4",
"Street": "sample string 5",
"Town": "sample string 6",
"Locality": "sample string 7",
"County": "sample string 8",
"Postcode": "sample string 9",
"LatitudeLongitude": "sample string 10"
}
}
],
"Roles": [
{
"Id": 1,
"RoleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"RoleStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
},
{
"Id": 1,
"RoleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"RoleStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
}
],
"EventCategory": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Branch": {
"Id": 1,
"Name": "sample string 2"
}
},
{
"Id": 1,
"AllDayEvent": true,
"BranchId": 3,
"Name": "sample string 4",
"Description": "sample string 5",
"StartDate": "2026-07-23T10:33:41.3735456Z",
"EndDate": "2026-07-23T10:33:41.3735456Z",
"DateTime": "2026-07-23T10:33:41.3735456Z",
"MeetingPlace": {
"AddressId": 1
},
"AttendingGroups": [
{
"EventId": 1,
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"AttendingPeople": [
{
"Id": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3"
},
{
"Id": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3"
}
],
"Group": {
"Id": 1,
"Name": "sample string 2",
"OwningTeamId": 3,
"OwningTeamName": "sample string 4",
"BranchId": 5,
"Description": "sample string 6",
"Notes": "sample string 7",
"GroupType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Grade": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FinancialStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"PrimaryGroupMember": {
"Id": 1,
"Title": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"ContactName": "sample string 5",
"PrimaryEmail": {
"Value": "sample string 1",
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"AllowContact": true
},
"PrimaryTelephone": {
"Value": "sample string 1",
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"AllowContact": true
}
},
"BranchOwningTeam": "sample string 8"
}
},
{
"EventId": 1,
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"AttendingPeople": [
{
"Id": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3"
},
{
"Id": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3"
}
],
"Group": {
"Id": 1,
"Name": "sample string 2",
"OwningTeamId": 3,
"OwningTeamName": "sample string 4",
"BranchId": 5,
"Description": "sample string 6",
"Notes": "sample string 7",
"GroupType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Grade": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FinancialStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"PrimaryGroupMember": {
"Id": 1,
"Title": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"ContactName": "sample string 5",
"PrimaryEmail": {
"Value": "sample string 1",
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"AllowContact": true
},
"PrimaryTelephone": {
"Value": "sample string 1",
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"AllowContact": true
}
},
"BranchOwningTeam": "sample string 8"
}
}
],
"Negotiators": [
{
"Id": 1,
"EventId": 2,
"ContactName": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5"
},
{
"Id": 1,
"EventId": 2,
"ContactName": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5"
}
],
"Properties": [
{
"Id": 1,
"Address": {
"Id": 1,
"Number": "sample string 2",
"BuildingName": "sample string 3",
"OrganizationName": "sample string 4",
"Street": "sample string 5",
"Town": "sample string 6",
"Locality": "sample string 7",
"County": "sample string 8",
"Postcode": "sample string 9",
"LatitudeLongitude": "sample string 10"
}
},
{
"Id": 1,
"Address": {
"Id": 1,
"Number": "sample string 2",
"BuildingName": "sample string 3",
"OrganizationName": "sample string 4",
"Street": "sample string 5",
"Town": "sample string 6",
"Locality": "sample string 7",
"County": "sample string 8",
"Postcode": "sample string 9",
"LatitudeLongitude": "sample string 10"
}
}
],
"Roles": [
{
"Id": 1,
"RoleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"RoleStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
},
{
"Id": 1,
"RoleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"RoleStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
}
],
"EventCategory": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Branch": {
"Id": 1,
"Name": "sample string 2"
}
}
]
}