GET api/appointmentrequests/search?alreadySent={alreadySent}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of appointment requests with patient data in case of new patients.

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.

Resource Description

ListModelOfPatientAppointmentRequestModel

Name	Type	Additional information
TotalItems	integer	None.
ItemsPerPage	integer	None.
CurrentPage	integer	None.
TotalPages	integer	None.
FirstRowOnPage	integer	None.
LastRowOnPage	integer	None.
Rows	Collection of PatientAppointmentRequestModel	None.

Response Formats

application/json, text/json

Sample:

{
  "totalItems": 1,
  "itemsPerPage": 2,
  "currentPage": 3,
  "totalPages": 4,
  "firstRowOnPage": 5,
  "lastRowOnPage": 6,
  "rows": [
    {
      "appointmentRequestList": [
        {
          "appointmentRequestID": "0957bad7-d15e-460f-b22c-1ae085c9241b",
          "visionInsuranceCarrier": "sample string 2",
          "visionGroupNumber": "sample string 3",
          "visionPolicyNumber": "sample string 4",
          "medicalInsuranceCarrier": "sample string 5",
          "medicalGroupNumber": "sample string 6",
          "medicalPolicyNumber": "sample string 7",
          "requestedDate": "2026-07-14T01:55:16.6838703+00:00",
          "comments": "sample string 9",
          "patientEmailAddress": "sample string 10",
          "phoneNumberType": "sample string 11",
          "phoneNumber": "sample string 12",
          "status": "sample string 13",
          "appointmentRequestReasonId": "df5380ac-2526-475a-b060-791bbf1eaca4",
          "countryId": "cf7571c3-f62a-4d51-9f48-c981534de505",
          "appointmentExternalId": "sample string 15",
          "doctorExternalId": "sample string 16",
          "locationExternalId": "sample string 17"
        },
        {
          "appointmentRequestID": "0957bad7-d15e-460f-b22c-1ae085c9241b",
          "visionInsuranceCarrier": "sample string 2",
          "visionGroupNumber": "sample string 3",
          "visionPolicyNumber": "sample string 4",
          "medicalInsuranceCarrier": "sample string 5",
          "medicalGroupNumber": "sample string 6",
          "medicalPolicyNumber": "sample string 7",
          "requestedDate": "2026-07-14T01:55:16.6838703+00:00",
          "comments": "sample string 9",
          "patientEmailAddress": "sample string 10",
          "phoneNumberType": "sample string 11",
          "phoneNumber": "sample string 12",
          "status": "sample string 13",
          "appointmentRequestReasonId": "df5380ac-2526-475a-b060-791bbf1eaca4",
          "countryId": "cf7571c3-f62a-4d51-9f48-c981534de505",
          "appointmentExternalId": "sample string 15",
          "doctorExternalId": "sample string 16",
          "locationExternalId": "sample string 17"
        }
      ],
      "isPortalPatient": true,
      "patientExternalId": "sample string 2",
      "portalPatient": {
        "id": "91076754-6d46-4637-828d-d2a7ead4f80e",
        "portalCreated": "2026-07-14T01:55:16.6785514+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-07-14T01:55:16.6830723+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": "0957bad7-d15e-460f-b22c-1ae085c9241b",
          "visionInsuranceCarrier": "sample string 2",
          "visionGroupNumber": "sample string 3",
          "visionPolicyNumber": "sample string 4",
          "medicalInsuranceCarrier": "sample string 5",
          "medicalGroupNumber": "sample string 6",
          "medicalPolicyNumber": "sample string 7",
          "requestedDate": "2026-07-14T01:55:16.6838703+00:00",
          "comments": "sample string 9",
          "patientEmailAddress": "sample string 10",
          "phoneNumberType": "sample string 11",
          "phoneNumber": "sample string 12",
          "status": "sample string 13",
          "appointmentRequestReasonId": "df5380ac-2526-475a-b060-791bbf1eaca4",
          "countryId": "cf7571c3-f62a-4d51-9f48-c981534de505",
          "appointmentExternalId": "sample string 15",
          "doctorExternalId": "sample string 16",
          "locationExternalId": "sample string 17"
        },
        {
          "appointmentRequestID": "0957bad7-d15e-460f-b22c-1ae085c9241b",
          "visionInsuranceCarrier": "sample string 2",
          "visionGroupNumber": "sample string 3",
          "visionPolicyNumber": "sample string 4",
          "medicalInsuranceCarrier": "sample string 5",
          "medicalGroupNumber": "sample string 6",
          "medicalPolicyNumber": "sample string 7",
          "requestedDate": "2026-07-14T01:55:16.6838703+00:00",
          "comments": "sample string 9",
          "patientEmailAddress": "sample string 10",
          "phoneNumberType": "sample string 11",
          "phoneNumber": "sample string 12",
          "status": "sample string 13",
          "appointmentRequestReasonId": "df5380ac-2526-475a-b060-791bbf1eaca4",
          "countryId": "cf7571c3-f62a-4d51-9f48-c981534de505",
          "appointmentExternalId": "sample string 15",
          "doctorExternalId": "sample string 16",
          "locationExternalId": "sample string 17"
        }
      ],
      "isPortalPatient": true,
      "patientExternalId": "sample string 2",
      "portalPatient": {
        "id": "91076754-6d46-4637-828d-d2a7ead4f80e",
        "portalCreated": "2026-07-14T01:55:16.6785514+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-07-14T01:55:16.6830723+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:

<ListModelOfPatientAppointmentRequestModel1OsnQyfP 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.AppointmentRequests">
    <d2p1:PatientAppointmentRequestModel>
      <d2p1:AppointmentRequestList>
        <d2p1:AppointmentRequestModel>
          <d2p1:AppointmentExternalId>sample string 15</d2p1:AppointmentExternalId>
          <d2p1:AppointmentRequestID>0957bad7-d15e-460f-b22c-1ae085c9241b</d2p1:AppointmentRequestID>
          <d2p1:AppointmentRequestReasonId>df5380ac-2526-475a-b060-791bbf1eaca4</d2p1:AppointmentRequestReasonId>
          <d2p1:Comments>sample string 9</d2p1:Comments>
          <d2p1:CountryId>cf7571c3-f62a-4d51-9f48-c981534de505</d2p1:CountryId>
          <d2p1:DoctorExternalId>sample string 16</d2p1:DoctorExternalId>
          <d2p1:LocationExternalId>sample string 17</d2p1:LocationExternalId>
          <d2p1:MedicalGroupNumber>sample string 6</d2p1:MedicalGroupNumber>
          <d2p1:MedicalInsuranceCarrier>sample string 5</d2p1:MedicalInsuranceCarrier>
          <d2p1:MedicalPolicyNumber>sample string 7</d2p1:MedicalPolicyNumber>
          <d2p1:PatientEmailAddress>sample string 10</d2p1:PatientEmailAddress>
          <d2p1:PhoneNumber>sample string 12</d2p1:PhoneNumber>
          <d2p1:PhoneNumberType>sample string 11</d2p1:PhoneNumberType>
          <d2p1:RequestedDate>2026-07-14T01:55:16.6838703+00:00</d2p1:RequestedDate>
          <d2p1:Status>sample string 13</d2p1:Status>
          <d2p1:VisionGroupNumber>sample string 3</d2p1:VisionGroupNumber>
          <d2p1:VisionInsuranceCarrier>sample string 2</d2p1:VisionInsuranceCarrier>
          <d2p1:VisionPolicyNumber>sample string 4</d2p1:VisionPolicyNumber>
        </d2p1:AppointmentRequestModel>
        <d2p1:AppointmentRequestModel>
          <d2p1:AppointmentExternalId>sample string 15</d2p1:AppointmentExternalId>
          <d2p1:AppointmentRequestID>0957bad7-d15e-460f-b22c-1ae085c9241b</d2p1:AppointmentRequestID>
          <d2p1:AppointmentRequestReasonId>df5380ac-2526-475a-b060-791bbf1eaca4</d2p1:AppointmentRequestReasonId>
          <d2p1:Comments>sample string 9</d2p1:Comments>
          <d2p1:CountryId>cf7571c3-f62a-4d51-9f48-c981534de505</d2p1:CountryId>
          <d2p1:DoctorExternalId>sample string 16</d2p1:DoctorExternalId>
          <d2p1:LocationExternalId>sample string 17</d2p1:LocationExternalId>
          <d2p1:MedicalGroupNumber>sample string 6</d2p1:MedicalGroupNumber>
          <d2p1:MedicalInsuranceCarrier>sample string 5</d2p1:MedicalInsuranceCarrier>
          <d2p1:MedicalPolicyNumber>sample string 7</d2p1:MedicalPolicyNumber>
          <d2p1:PatientEmailAddress>sample string 10</d2p1:PatientEmailAddress>
          <d2p1:PhoneNumber>sample string 12</d2p1:PhoneNumber>
          <d2p1:PhoneNumberType>sample string 11</d2p1:PhoneNumberType>
          <d2p1:RequestedDate>2026-07-14T01:55:16.6838703+00:00</d2p1:RequestedDate>
          <d2p1:Status>sample string 13</d2p1:Status>
          <d2p1:VisionGroupNumber>sample string 3</d2p1:VisionGroupNumber>
          <d2p1:VisionInsuranceCarrier>sample string 2</d2p1:VisionInsuranceCarrier>
          <d2p1:VisionPolicyNumber>sample string 4</d2p1:VisionPolicyNumber>
        </d2p1:AppointmentRequestModel>
      </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-07-14T01:55:16.6830723+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>91076754-6d46-4637-828d-d2a7ead4f80e</d4p1:Id>
        <d4p1:LastName>sample string 6</d4p1:LastName>
        <d4p1:MiddleName>sample string 5</d4p1:MiddleName>
        <d4p1:PortalCreated>2026-07-14T01:55:16.6785514+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:PatientAppointmentRequestModel>
    <d2p1:PatientAppointmentRequestModel>
      <d2p1:AppointmentRequestList>
        <d2p1:AppointmentRequestModel>
          <d2p1:AppointmentExternalId>sample string 15</d2p1:AppointmentExternalId>
          <d2p1:AppointmentRequestID>0957bad7-d15e-460f-b22c-1ae085c9241b</d2p1:AppointmentRequestID>
          <d2p1:AppointmentRequestReasonId>df5380ac-2526-475a-b060-791bbf1eaca4</d2p1:AppointmentRequestReasonId>
          <d2p1:Comments>sample string 9</d2p1:Comments>
          <d2p1:CountryId>cf7571c3-f62a-4d51-9f48-c981534de505</d2p1:CountryId>
          <d2p1:DoctorExternalId>sample string 16</d2p1:DoctorExternalId>
          <d2p1:LocationExternalId>sample string 17</d2p1:LocationExternalId>
          <d2p1:MedicalGroupNumber>sample string 6</d2p1:MedicalGroupNumber>
          <d2p1:MedicalInsuranceCarrier>sample string 5</d2p1:MedicalInsuranceCarrier>
          <d2p1:MedicalPolicyNumber>sample string 7</d2p1:MedicalPolicyNumber>
          <d2p1:PatientEmailAddress>sample string 10</d2p1:PatientEmailAddress>
          <d2p1:PhoneNumber>sample string 12</d2p1:PhoneNumber>
          <d2p1:PhoneNumberType>sample string 11</d2p1:PhoneNumberType>
          <d2p1:RequestedDate>2026-07-14T01:55:16.6838703+00:00</d2p1:RequestedDate>
          <d2p1:Status>sample string 13</d2p1:Status>
          <d2p1:VisionGroupNumber>sample string 3</d2p1:VisionGroupNumber>
          <d2p1:VisionInsuranceCarrier>sample string 2</d2p1:VisionInsuranceCarrier>
          <d2p1:VisionPolicyNumber>sample string 4</d2p1:VisionPolicyNumber>
        </d2p1:AppointmentRequestModel>
        <d2p1:AppointmentRequestModel>
          <d2p1:AppointmentExternalId>sample string 15</d2p1:AppointmentExternalId>
          <d2p1:AppointmentRequestID>0957bad7-d15e-460f-b22c-1ae085c9241b</d2p1:AppointmentRequestID>
          <d2p1:AppointmentRequestReasonId>df5380ac-2526-475a-b060-791bbf1eaca4</d2p1:AppointmentRequestReasonId>
          <d2p1:Comments>sample string 9</d2p1:Comments>
          <d2p1:CountryId>cf7571c3-f62a-4d51-9f48-c981534de505</d2p1:CountryId>
          <d2p1:DoctorExternalId>sample string 16</d2p1:DoctorExternalId>
          <d2p1:LocationExternalId>sample string 17</d2p1:LocationExternalId>
          <d2p1:MedicalGroupNumber>sample string 6</d2p1:MedicalGroupNumber>
          <d2p1:MedicalInsuranceCarrier>sample string 5</d2p1:MedicalInsuranceCarrier>
          <d2p1:MedicalPolicyNumber>sample string 7</d2p1:MedicalPolicyNumber>
          <d2p1:PatientEmailAddress>sample string 10</d2p1:PatientEmailAddress>
          <d2p1:PhoneNumber>sample string 12</d2p1:PhoneNumber>
          <d2p1:PhoneNumberType>sample string 11</d2p1:PhoneNumberType>
          <d2p1:RequestedDate>2026-07-14T01:55:16.6838703+00:00</d2p1:RequestedDate>
          <d2p1:Status>sample string 13</d2p1:Status>
          <d2p1:VisionGroupNumber>sample string 3</d2p1:VisionGroupNumber>
          <d2p1:VisionInsuranceCarrier>sample string 2</d2p1:VisionInsuranceCarrier>
          <d2p1:VisionPolicyNumber>sample string 4</d2p1:VisionPolicyNumber>
        </d2p1:AppointmentRequestModel>
      </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-07-14T01:55:16.6830723+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>91076754-6d46-4637-828d-d2a7ead4f80e</d4p1:Id>
        <d4p1:LastName>sample string 6</d4p1:LastName>
        <d4p1:MiddleName>sample string 5</d4p1:MiddleName>
        <d4p1:PortalCreated>2026-07-14T01:55:16.6785514+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:PatientAppointmentRequestModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfPatientAppointmentRequestModel1OsnQyfP>

Eye Reach Patients API Reference

GET api/appointmentrequests/search?alreadySent={alreadySent}&page={page}&itemsPerPage={itemsPerPage}

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml