GET api/contacts/{id}/emailcommunications?offset={offset}&limit={limit}&returnTotal={returnTotal}

Get all EmailCommunications that are related to the supplied Contact id.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The primary key of the Contact record.	integer	Required
offset	The position in the collection of EmailCommunications from which to start returning data from.	integer	Default value is 0
limit	The maximum amount of EmailCommunications that can be returned in any one call. Maximum allowed is 250.	integer	Default value is 50
returnTotal	Whether to include the total amount of EmailCommunications in the database that match the filter specified.	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

EmailCommunicationDto

Name	Description	Type	Additional information
Id	The primary key of the record in the Hobsons database. Ignored for POST requests sent to the API.	integer	None.
CrmNumber	A reference to the primary key of the Contact record that is associated with this record.	integer	Required Range: inclusive between 1 and 2147483647
Subject	The email subject. Required if communication is outgoing (i.e. Incoming=false).	string	String length: inclusive between 0 and 1000
Headline	The email headline.	string	String length: inclusive between 0 and 400
Incoming	Indicates if email communication is incoming (true) or outgoing (false).	boolean	Required
CommunicationTypeId	A reference to the primary key of the CommunicationType record that is associated with this record.	integer	Required Range: inclusive between 1 and 99999999
CommunicationTypeName	The name of the CommunicationType record that is associated with this record. Ignored for POST requests sent to the API.	string	None.
From	The communication's From address.	string	Required String length: inclusive between 0 and 254
To	The communication's To address(es).	string	Required String length: inclusive between 0 and 4000
Cc	The communication's CC address(es).	string	String length: inclusive between 0 and 4000
Bcc	The communication's BCC address(es).	string	String length: inclusive between 0 and 4000
SubChannelId	A reference to the primary key of the SubChannel record that is associated with this record. For POST requests sent to the API, the SubChannel record must belong to the parent Channel named 'External'.	integer	Required Range: inclusive between 1 and 99999999
SubChannelName	The name of the SubChannel record that is associated with this record. Ignored for POST requests sent to the API.	string	None.
ChannelId	A reference to the primary key of the Channel record that is the parent of the SubChannel record. Ignored for POST requests sent to the API.	integer	None.
ChannelName	The name of the Channel record that is the parent of the SubChannel record. Ignored for POST requests sent to the API.	string	None.
Source	The source of the communication.	string	String length: inclusive between 0 and 1000
ReferralSource	The referral source of the communication.	string	String length: inclusive between 0 and 1000
DateCreated	The date that the communication record was created (in the Hobsons database). Ignored for POST requests sent to the API.	date	None.
Task	The details of the Task record created that it's associated with this record. Used ONLY for POST requests sent to the API. Always returned as NULL.	InnerTaskDto	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "CrmNumber": 1,
  "Subject": "sample string 2",
  "Headline": "sample string 3",
  "Incoming": true,
  "CommunicationTypeId": 1,
  "CommunicationTypeName": "sample string 5",
  "From": "sample string 6",
  "To": "sample string 7",
  "Cc": "sample string 8",
  "Bcc": "sample string 9",
  "SubChannelId": 1,
  "SubChannelName": "sample string 10",
  "ChannelId": 1,
  "ChannelName": "sample string 11",
  "Source": "sample string 12",
  "ReferralSource": "sample string 13",
  "DateCreated": "2024-05-20T08:36:33.9978501+10:00",
  "Task": {
    "TaskTypeId": 1,
    "Description": "sample string 2"
  }
}