GET api/appointmentrequestslimited/search?alreadySent={alreadySent}&page={page}&itemsPerPage={itemsPerPage}
Returns a list of appointment requests limited with patient data in case of new patients.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| alreadySent |
Filter appointment requests on whether they are already send or not. |
boolean |
Default value is False |
| page |
Page number requested (search results are paginated). |
integer |
Default value is 1 |
| itemsPerPage |
Items to return on each page. See page parameter above. |
integer |
Default value is 10 |
Body Parameters
None.
Response Information
Resource Description
ListModelOfPatientAppointmentRequestLimitedModel| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalItems | integer |
None. |
|
| ItemsPerPage | integer |
None. |
|
| CurrentPage | integer |
None. |
|
| TotalPages | integer |
None. |
|
| FirstRowOnPage | integer |
None. |
|
| LastRowOnPage | integer |
None. |
|
| Rows | Collection of PatientAppointmentRequestLimitedModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"totalItems": 1,
"itemsPerPage": 2,
"currentPage": 3,
"totalPages": 4,
"firstRowOnPage": 5,
"lastRowOnPage": 6,
"rows": [
{
"appointmentRequestList": [
{
"appointmentRequestID": "04cdfc88-414a-4b3c-90ec-452c5768fa3e",
"visionInsuranceCarrier": "sample string 2",
"visionGroupNumber": "sample string 3",
"visionPolicyNumber": "sample string 4",
"medicalInsuranceCarrier": "sample string 5",
"medicalGroupNumber": "sample string 6",
"medicalPolicyNumber": "sample string 7",
"patientEmailAddress": "sample string 8",
"phoneNumberType": "sample string 9",
"phoneNumber": "sample string 10",
"status": "sample string 11",
"appointmentRequestReasonId": "1a555101-dffe-4d69-bd9a-5341fe8eb248",
"countryId": "7c44cc22-0c7f-41df-a8b0-8b3a0775f218",
"appointmentExternalId": "sample string 13",
"doctorExternalId": "sample string 14",
"locationExternalId": "sample string 15",
"dateRangeFrom": "2026-05-29T16:59:22.19158+00:00",
"dateRangeTo": "2026-05-29T16:59:22.19158+00:00",
"preferredTime": "sample string 16",
"sundaySelected": true,
"mondaySelected": true,
"tuesdaySelected": true,
"wednesdaySelected": true,
"thursdaySelected": true,
"fridaySelected": true,
"saturdaySelected": true,
"comments": "sample string 24"
},
{
"appointmentRequestID": "04cdfc88-414a-4b3c-90ec-452c5768fa3e",
"visionInsuranceCarrier": "sample string 2",
"visionGroupNumber": "sample string 3",
"visionPolicyNumber": "sample string 4",
"medicalInsuranceCarrier": "sample string 5",
"medicalGroupNumber": "sample string 6",
"medicalPolicyNumber": "sample string 7",
"patientEmailAddress": "sample string 8",
"phoneNumberType": "sample string 9",
"phoneNumber": "sample string 10",
"status": "sample string 11",
"appointmentRequestReasonId": "1a555101-dffe-4d69-bd9a-5341fe8eb248",
"countryId": "7c44cc22-0c7f-41df-a8b0-8b3a0775f218",
"appointmentExternalId": "sample string 13",
"doctorExternalId": "sample string 14",
"locationExternalId": "sample string 15",
"dateRangeFrom": "2026-05-29T16:59:22.19158+00:00",
"dateRangeTo": "2026-05-29T16:59:22.19158+00:00",
"preferredTime": "sample string 16",
"sundaySelected": true,
"mondaySelected": true,
"tuesdaySelected": true,
"wednesdaySelected": true,
"thursdaySelected": true,
"fridaySelected": true,
"saturdaySelected": true,
"comments": "sample string 24"
}
],
"isPortalPatient": true,
"patientExternalId": "sample string 2",
"portalPatient": {
"id": "c363c07b-b133-412a-a322-b636c3620541",
"portalCreated": "2026-05-29T16:59:22.19158+00:00",
"contactPrefixExternalId": "sample string 3",
"firstName": "sample string 4",
"middleName": "sample string 5",
"lastName": "sample string 6",
"contactSuffixExternalId": "sample string 7",
"sexExternalId": "sample string 8",
"username": "sample string 9",
"birthday": "2026-05-29T16:59:22.19158+00:00",
"address1": "sample string 10",
"address2": "sample string 11",
"city": "sample string 12",
"state": "sample string 13",
"zipCode": "sample string 14",
"countryName": "sample string 15",
"communicationsVoicePhone": "sample string 16",
"communicationsTextPhone": "sample string 17",
"communicationsEmail": "sample string 18"
}
},
{
"appointmentRequestList": [
{
"appointmentRequestID": "04cdfc88-414a-4b3c-90ec-452c5768fa3e",
"visionInsuranceCarrier": "sample string 2",
"visionGroupNumber": "sample string 3",
"visionPolicyNumber": "sample string 4",
"medicalInsuranceCarrier": "sample string 5",
"medicalGroupNumber": "sample string 6",
"medicalPolicyNumber": "sample string 7",
"patientEmailAddress": "sample string 8",
"phoneNumberType": "sample string 9",
"phoneNumber": "sample string 10",
"status": "sample string 11",
"appointmentRequestReasonId": "1a555101-dffe-4d69-bd9a-5341fe8eb248",
"countryId": "7c44cc22-0c7f-41df-a8b0-8b3a0775f218",
"appointmentExternalId": "sample string 13",
"doctorExternalId": "sample string 14",
"locationExternalId": "sample string 15",
"dateRangeFrom": "2026-05-29T16:59:22.19158+00:00",
"dateRangeTo": "2026-05-29T16:59:22.19158+00:00",
"preferredTime": "sample string 16",
"sundaySelected": true,
"mondaySelected": true,
"tuesdaySelected": true,
"wednesdaySelected": true,
"thursdaySelected": true,
"fridaySelected": true,
"saturdaySelected": true,
"comments": "sample string 24"
},
{
"appointmentRequestID": "04cdfc88-414a-4b3c-90ec-452c5768fa3e",
"visionInsuranceCarrier": "sample string 2",
"visionGroupNumber": "sample string 3",
"visionPolicyNumber": "sample string 4",
"medicalInsuranceCarrier": "sample string 5",
"medicalGroupNumber": "sample string 6",
"medicalPolicyNumber": "sample string 7",
"patientEmailAddress": "sample string 8",
"phoneNumberType": "sample string 9",
"phoneNumber": "sample string 10",
"status": "sample string 11",
"appointmentRequestReasonId": "1a555101-dffe-4d69-bd9a-5341fe8eb248",
"countryId": "7c44cc22-0c7f-41df-a8b0-8b3a0775f218",
"appointmentExternalId": "sample string 13",
"doctorExternalId": "sample string 14",
"locationExternalId": "sample string 15",
"dateRangeFrom": "2026-05-29T16:59:22.19158+00:00",
"dateRangeTo": "2026-05-29T16:59:22.19158+00:00",
"preferredTime": "sample string 16",
"sundaySelected": true,
"mondaySelected": true,
"tuesdaySelected": true,
"wednesdaySelected": true,
"thursdaySelected": true,
"fridaySelected": true,
"saturdaySelected": true,
"comments": "sample string 24"
}
],
"isPortalPatient": true,
"patientExternalId": "sample string 2",
"portalPatient": {
"id": "c363c07b-b133-412a-a322-b636c3620541",
"portalCreated": "2026-05-29T16:59:22.19158+00:00",
"contactPrefixExternalId": "sample string 3",
"firstName": "sample string 4",
"middleName": "sample string 5",
"lastName": "sample string 6",
"contactSuffixExternalId": "sample string 7",
"sexExternalId": "sample string 8",
"username": "sample string 9",
"birthday": "2026-05-29T16:59:22.19158+00:00",
"address1": "sample string 10",
"address2": "sample string 11",
"city": "sample string 12",
"state": "sample string 13",
"zipCode": "sample string 14",
"countryName": "sample string 15",
"communicationsVoicePhone": "sample string 16",
"communicationsTextPhone": "sample string 17",
"communicationsEmail": "sample string 18"
}
}
]
}
application/xml, text/xml
Sample:
<ListModelOfPatientAppointmentRequestLimitedModel5cqQT0jo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">
<CurrentPage>3</CurrentPage>
<FirstRowOnPage>5</FirstRowOnPage>
<ItemsPerPage>2</ItemsPerPage>
<LastRowOnPage>6</LastRowOnPage>
<Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.AppointmentRequestsLimited">
<d2p1:PatientAppointmentRequestLimitedModel>
<d2p1:AppointmentRequestList>
<d2p1:AppointmentRequestLimitedModel>
<d2p1:AppointmentExternalId>sample string 13</d2p1:AppointmentExternalId>
<d2p1:AppointmentRequestID>04cdfc88-414a-4b3c-90ec-452c5768fa3e</d2p1:AppointmentRequestID>
<d2p1:AppointmentRequestReasonId>1a555101-dffe-4d69-bd9a-5341fe8eb248</d2p1:AppointmentRequestReasonId>
<d2p1:Comments>sample string 24</d2p1:Comments>
<d2p1:CountryId>7c44cc22-0c7f-41df-a8b0-8b3a0775f218</d2p1:CountryId>
<d2p1:DateRangeFrom>2026-05-29T16:59:22.19158+00:00</d2p1:DateRangeFrom>
<d2p1:DateRangeTo>2026-05-29T16:59:22.19158+00:00</d2p1:DateRangeTo>
<d2p1:DoctorExternalId>sample string 14</d2p1:DoctorExternalId>
<d2p1:FridaySelected>true</d2p1:FridaySelected>
<d2p1:LocationExternalId>sample string 15</d2p1:LocationExternalId>
<d2p1:MedicalGroupNumber>sample string 6</d2p1:MedicalGroupNumber>
<d2p1:MedicalInsuranceCarrier>sample string 5</d2p1:MedicalInsuranceCarrier>
<d2p1:MedicalPolicyNumber>sample string 7</d2p1:MedicalPolicyNumber>
<d2p1:MondaySelected>true</d2p1:MondaySelected>
<d2p1:PatientEmailAddress>sample string 8</d2p1:PatientEmailAddress>
<d2p1:PhoneNumber>sample string 10</d2p1:PhoneNumber>
<d2p1:PhoneNumberType>sample string 9</d2p1:PhoneNumberType>
<d2p1:PreferredTime>sample string 16</d2p1:PreferredTime>
<d2p1:SaturdaySelected>true</d2p1:SaturdaySelected>
<d2p1:Status>sample string 11</d2p1:Status>
<d2p1:SundaySelected>true</d2p1:SundaySelected>
<d2p1:ThursdaySelected>true</d2p1:ThursdaySelected>
<d2p1:TuesdaySelected>true</d2p1:TuesdaySelected>
<d2p1:VisionGroupNumber>sample string 3</d2p1:VisionGroupNumber>
<d2p1:VisionInsuranceCarrier>sample string 2</d2p1:VisionInsuranceCarrier>
<d2p1:VisionPolicyNumber>sample string 4</d2p1:VisionPolicyNumber>
<d2p1:WednesdaySelected>true</d2p1:WednesdaySelected>
</d2p1:AppointmentRequestLimitedModel>
<d2p1:AppointmentRequestLimitedModel>
<d2p1:AppointmentExternalId>sample string 13</d2p1:AppointmentExternalId>
<d2p1:AppointmentRequestID>04cdfc88-414a-4b3c-90ec-452c5768fa3e</d2p1:AppointmentRequestID>
<d2p1:AppointmentRequestReasonId>1a555101-dffe-4d69-bd9a-5341fe8eb248</d2p1:AppointmentRequestReasonId>
<d2p1:Comments>sample string 24</d2p1:Comments>
<d2p1:CountryId>7c44cc22-0c7f-41df-a8b0-8b3a0775f218</d2p1:CountryId>
<d2p1:DateRangeFrom>2026-05-29T16:59:22.19158+00:00</d2p1:DateRangeFrom>
<d2p1:DateRangeTo>2026-05-29T16:59:22.19158+00:00</d2p1:DateRangeTo>
<d2p1:DoctorExternalId>sample string 14</d2p1:DoctorExternalId>
<d2p1:FridaySelected>true</d2p1:FridaySelected>
<d2p1:LocationExternalId>sample string 15</d2p1:LocationExternalId>
<d2p1:MedicalGroupNumber>sample string 6</d2p1:MedicalGroupNumber>
<d2p1:MedicalInsuranceCarrier>sample string 5</d2p1:MedicalInsuranceCarrier>
<d2p1:MedicalPolicyNumber>sample string 7</d2p1:MedicalPolicyNumber>
<d2p1:MondaySelected>true</d2p1:MondaySelected>
<d2p1:PatientEmailAddress>sample string 8</d2p1:PatientEmailAddress>
<d2p1:PhoneNumber>sample string 10</d2p1:PhoneNumber>
<d2p1:PhoneNumberType>sample string 9</d2p1:PhoneNumberType>
<d2p1:PreferredTime>sample string 16</d2p1:PreferredTime>
<d2p1:SaturdaySelected>true</d2p1:SaturdaySelected>
<d2p1:Status>sample string 11</d2p1:Status>
<d2p1:SundaySelected>true</d2p1:SundaySelected>
<d2p1:ThursdaySelected>true</d2p1:ThursdaySelected>
<d2p1:TuesdaySelected>true</d2p1:TuesdaySelected>
<d2p1:VisionGroupNumber>sample string 3</d2p1:VisionGroupNumber>
<d2p1:VisionInsuranceCarrier>sample string 2</d2p1:VisionInsuranceCarrier>
<d2p1:VisionPolicyNumber>sample string 4</d2p1:VisionPolicyNumber>
<d2p1:WednesdaySelected>true</d2p1:WednesdaySelected>
</d2p1:AppointmentRequestLimitedModel>
</d2p1:AppointmentRequestList>
<d2p1:IsPortalPatient>true</d2p1:IsPortalPatient>
<d2p1:PatientExternalId>sample string 2</d2p1:PatientExternalId>
<d2p1:PortalPatient xmlns:d4p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.PortalPatients">
<d4p1:Address1>sample string 10</d4p1:Address1>
<d4p1:Address2>sample string 11</d4p1:Address2>
<d4p1:Birthday>2026-05-29T16:59:22.19158+00:00</d4p1:Birthday>
<d4p1:City>sample string 12</d4p1:City>
<d4p1:CommunicationsEmail>sample string 18</d4p1:CommunicationsEmail>
<d4p1:CommunicationsTextPhone>sample string 17</d4p1:CommunicationsTextPhone>
<d4p1:CommunicationsVoicePhone>sample string 16</d4p1:CommunicationsVoicePhone>
<d4p1:ContactPrefixExternalId>sample string 3</d4p1:ContactPrefixExternalId>
<d4p1:ContactSuffixExternalId>sample string 7</d4p1:ContactSuffixExternalId>
<d4p1:CountryName>sample string 15</d4p1:CountryName>
<d4p1:FirstName>sample string 4</d4p1:FirstName>
<d4p1:Id>c363c07b-b133-412a-a322-b636c3620541</d4p1:Id>
<d4p1:LastName>sample string 6</d4p1:LastName>
<d4p1:MiddleName>sample string 5</d4p1:MiddleName>
<d4p1:PortalCreated>2026-05-29T16:59:22.19158+00:00</d4p1:PortalCreated>
<d4p1:SexExternalId>sample string 8</d4p1:SexExternalId>
<d4p1:State>sample string 13</d4p1:State>
<d4p1:Username>sample string 9</d4p1:Username>
<d4p1:ZipCode>sample string 14</d4p1:ZipCode>
</d2p1:PortalPatient>
</d2p1:PatientAppointmentRequestLimitedModel>
<d2p1:PatientAppointmentRequestLimitedModel>
<d2p1:AppointmentRequestList>
<d2p1:AppointmentRequestLimitedModel>
<d2p1:AppointmentExternalId>sample string 13</d2p1:AppointmentExternalId>
<d2p1:AppointmentRequestID>04cdfc88-414a-4b3c-90ec-452c5768fa3e</d2p1:AppointmentRequestID>
<d2p1:AppointmentRequestReasonId>1a555101-dffe-4d69-bd9a-5341fe8eb248</d2p1:AppointmentRequestReasonId>
<d2p1:Comments>sample string 24</d2p1:Comments>
<d2p1:CountryId>7c44cc22-0c7f-41df-a8b0-8b3a0775f218</d2p1:CountryId>
<d2p1:DateRangeFrom>2026-05-29T16:59:22.19158+00:00</d2p1:DateRangeFrom>
<d2p1:DateRangeTo>2026-05-29T16:59:22.19158+00:00</d2p1:DateRangeTo>
<d2p1:DoctorExternalId>sample string 14</d2p1:DoctorExternalId>
<d2p1:FridaySelected>true</d2p1:FridaySelected>
<d2p1:LocationExternalId>sample string 15</d2p1:LocationExternalId>
<d2p1:MedicalGroupNumber>sample string 6</d2p1:MedicalGroupNumber>
<d2p1:MedicalInsuranceCarrier>sample string 5</d2p1:MedicalInsuranceCarrier>
<d2p1:MedicalPolicyNumber>sample string 7</d2p1:MedicalPolicyNumber>
<d2p1:MondaySelected>true</d2p1:MondaySelected>
<d2p1:PatientEmailAddress>sample string 8</d2p1:PatientEmailAddress>
<d2p1:PhoneNumber>sample string 10</d2p1:PhoneNumber>
<d2p1:PhoneNumberType>sample string 9</d2p1:PhoneNumberType>
<d2p1:PreferredTime>sample string 16</d2p1:PreferredTime>
<d2p1:SaturdaySelected>true</d2p1:SaturdaySelected>
<d2p1:Status>sample string 11</d2p1:Status>
<d2p1:SundaySelected>true</d2p1:SundaySelected>
<d2p1:ThursdaySelected>true</d2p1:ThursdaySelected>
<d2p1:TuesdaySelected>true</d2p1:TuesdaySelected>
<d2p1:VisionGroupNumber>sample string 3</d2p1:VisionGroupNumber>
<d2p1:VisionInsuranceCarrier>sample string 2</d2p1:VisionInsuranceCarrier>
<d2p1:VisionPolicyNumber>sample string 4</d2p1:VisionPolicyNumber>
<d2p1:WednesdaySelected>true</d2p1:WednesdaySelected>
</d2p1:AppointmentRequestLimitedModel>
<d2p1:AppointmentRequestLimitedModel>
<d2p1:AppointmentExternalId>sample string 13</d2p1:AppointmentExternalId>
<d2p1:AppointmentRequestID>04cdfc88-414a-4b3c-90ec-452c5768fa3e</d2p1:AppointmentRequestID>
<d2p1:AppointmentRequestReasonId>1a555101-dffe-4d69-bd9a-5341fe8eb248</d2p1:AppointmentRequestReasonId>
<d2p1:Comments>sample string 24</d2p1:Comments>
<d2p1:CountryId>7c44cc22-0c7f-41df-a8b0-8b3a0775f218</d2p1:CountryId>
<d2p1:DateRangeFrom>2026-05-29T16:59:22.19158+00:00</d2p1:DateRangeFrom>
<d2p1:DateRangeTo>2026-05-29T16:59:22.19158+00:00</d2p1:DateRangeTo>
<d2p1:DoctorExternalId>sample string 14</d2p1:DoctorExternalId>
<d2p1:FridaySelected>true</d2p1:FridaySelected>
<d2p1:LocationExternalId>sample string 15</d2p1:LocationExternalId>
<d2p1:MedicalGroupNumber>sample string 6</d2p1:MedicalGroupNumber>
<d2p1:MedicalInsuranceCarrier>sample string 5</d2p1:MedicalInsuranceCarrier>
<d2p1:MedicalPolicyNumber>sample string 7</d2p1:MedicalPolicyNumber>
<d2p1:MondaySelected>true</d2p1:MondaySelected>
<d2p1:PatientEmailAddress>sample string 8</d2p1:PatientEmailAddress>
<d2p1:PhoneNumber>sample string 10</d2p1:PhoneNumber>
<d2p1:PhoneNumberType>sample string 9</d2p1:PhoneNumberType>
<d2p1:PreferredTime>sample string 16</d2p1:PreferredTime>
<d2p1:SaturdaySelected>true</d2p1:SaturdaySelected>
<d2p1:Status>sample string 11</d2p1:Status>
<d2p1:SundaySelected>true</d2p1:SundaySelected>
<d2p1:ThursdaySelected>true</d2p1:ThursdaySelected>
<d2p1:TuesdaySelected>true</d2p1:TuesdaySelected>
<d2p1:VisionGroupNumber>sample string 3</d2p1:VisionGroupNumber>
<d2p1:VisionInsuranceCarrier>sample string 2</d2p1:VisionInsuranceCarrier>
<d2p1:VisionPolicyNumber>sample string 4</d2p1:VisionPolicyNumber>
<d2p1:WednesdaySelected>true</d2p1:WednesdaySelected>
</d2p1:AppointmentRequestLimitedModel>
</d2p1:AppointmentRequestList>
<d2p1:IsPortalPatient>true</d2p1:IsPortalPatient>
<d2p1:PatientExternalId>sample string 2</d2p1:PatientExternalId>
<d2p1:PortalPatient xmlns:d4p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.PortalPatients">
<d4p1:Address1>sample string 10</d4p1:Address1>
<d4p1:Address2>sample string 11</d4p1:Address2>
<d4p1:Birthday>2026-05-29T16:59:22.19158+00:00</d4p1:Birthday>
<d4p1:City>sample string 12</d4p1:City>
<d4p1:CommunicationsEmail>sample string 18</d4p1:CommunicationsEmail>
<d4p1:CommunicationsTextPhone>sample string 17</d4p1:CommunicationsTextPhone>
<d4p1:CommunicationsVoicePhone>sample string 16</d4p1:CommunicationsVoicePhone>
<d4p1:ContactPrefixExternalId>sample string 3</d4p1:ContactPrefixExternalId>
<d4p1:ContactSuffixExternalId>sample string 7</d4p1:ContactSuffixExternalId>
<d4p1:CountryName>sample string 15</d4p1:CountryName>
<d4p1:FirstName>sample string 4</d4p1:FirstName>
<d4p1:Id>c363c07b-b133-412a-a322-b636c3620541</d4p1:Id>
<d4p1:LastName>sample string 6</d4p1:LastName>
<d4p1:MiddleName>sample string 5</d4p1:MiddleName>
<d4p1:PortalCreated>2026-05-29T16:59:22.19158+00:00</d4p1:PortalCreated>
<d4p1:SexExternalId>sample string 8</d4p1:SexExternalId>
<d4p1:State>sample string 13</d4p1:State>
<d4p1:Username>sample string 9</d4p1:Username>
<d4p1:ZipCode>sample string 14</d4p1:ZipCode>
</d2p1:PortalPatient>
</d2p1:PatientAppointmentRequestLimitedModel>
</Rows>
<TotalItems>1</TotalItems>
<TotalPages>4</TotalPages>
</ListModelOfPatientAppointmentRequestLimitedModel5cqQT0jo>