GetCommunicationHistory()

The GetCommunicationHistory() command returns a list of communication history (i.e. e-mails sent) that satisfy the given filter parameters.

  • Quota: 2
Table 1. Parameters
ParameterTypeMax LengthRequiredDescription
apiTokenstring20YYour API security token configured in Field View.
projectIDintegerYThe unique ID of the project.
emailTostring20YFilters the returned results where the email 'to' contains the supplied string.
emailSubjectstring20YFilters the returned results where the email 'subject' contains the supplied string.
notSentbooleanYIf false, all communication history is returned. If true, only the communication history that failed to get sent is returned.
dateFromDateTimeThe date sent from communication history results to retrieve.
dateToDateTimeThe date sent to communication history results to retrieve.
Note: Date range must be 3 months or less.
Table 2. Returns
FieldTypeDescription
CommunicationHistoryInformationCommunicationHistoryInformationCommunication history list information structure.
<CommunicationHistoryResponse>
       <Status>
           SUCCESS
           <Message>Success.</Message>
       </Status>
       <CommunicationHistoryInformation>
           <SubscriptionID></SubscriptionID>
           <ProjectID></ProjectID>
           <ProjectName></ProjectName>
           <To></To>
           <Subject></Subject>
           <CC></CC>
           <Body></Body>
           <Sent></Sent>
           <Date></Date>
       </CommunicationHistoryInformation>
   </CommunicationHistoryResponse>