POST Agents/EMail/GetEMail

• 6 minutes to read

POST /api/v1/Agents/EMail/GetEMail

Get en e-mail based on its primary key in the DB

NsApiSlow threshold: 5000 ms.

Online Restricted: ## The EMail agent is not available in Online by default. Access must be requested specifically when app is registered.

Query String Parameters

Parameter Name	Type	Description
$select	string	Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

POST /api/v1/Agents/EMail/GetEMail?$select=name,department,category/id

Request Headers

Parameter Name	Description
Authorization	Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN	If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type	Content-type of the request body: `application/json`, `text/json`, `application/xml`, `text/xml`, `application/x-www-form-urlencoded`, `application/json-patch+json`, `application/merge-patch+json`
Accept	Content-type(s) you would like the response in: `application/json`, `text/json`, `application/xml`, `text/xml`, `application/json-patch+json`, `application/merge-patch+json`
Accept-Language	Convert string references and multi-language values into a specified language (iso2) code.
SO-Language	Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture	Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone	Specify the timezone code that you would like date/time responses converted to.
SO-AppToken	The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

Id, IncludeAttachments

Property Name	Type	Description
Id	Integer
IncludeAttachments	Boolean

Response:

Response	Description
200	OK

Response body: EMailEntity

Property Name	Type	Description
To	array	To recipients of e-mail
Cc	array	Cc recipients of e-mail
Bcc	array	Bcc recipient of e-mail
Subject	string	Subject of the e-mail
HTMLBody	string	Body formatted in HTML
From	EMailAddress	Who did the e-mail originate from
Sent	date-time	When was the e-mail sent
Size	int32	Total size of the e-mail
Priority	string	Importance of the e-mail
Flags	string	Flag status of this mail (unread, replied, deleted )
MessageID	string	Unique id of e-mails
PlainBody	string	Body formatted in plain text
IsSent	bool	Is this a sent e-mail (not new)
EMailSOInfo	EMailSOInfo	Glue between SuperOffice data and an e-mail.
ServerId	int32	Unique id for the e-mail on the server
Attachments	array
CustomHeaderList	array	Non standard e-mail headers
FolderName	string	Name of folder the e-mail belongs in
EmailItemId	int32	Primary key
AccountId	int32	Account Id
ReceivedAt	date-time	Received date time
InReplyTo	EMailEnvelope	The envelope of the email this email is a reply to, if it exists
RepliedAt	date-time	When this email was replied at
HasCalendarData	bool	If this email contains exactly one iCal appointment
CalMethod	string	Method stored in the associated iCal appointment. Indicates if the iCal data is a reply, counter proposal etc.
CalReplyStatus	string	Reply status stored in calendar data for the ical method is REPLY
TableRight	TableRight	The carrier's table right
FieldProperties	object	Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/EMail/GetEMail
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv
Content-Type: application/json; charset=utf-8

{
  "Id": 255,
  "IncludeAttachments": true
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "To": [
    {
      "ContactId": 975,
      "ContactName": "Osinski, Stamm and Funk",
      "PersonId": 605,
      "PersonName": "Botsford LLC",
      "AssociateId": 241,
      "Address": "ullam",
      "EmailId": 652,
      "DuplicatePersonIds": [
        901,
        162
      ],
      "Name": "Rosenbaum-Schuppe",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 112
        }
      }
    }
  ],
  "Cc": [
    {
      "ContactId": 241,
      "ContactName": "Zboncak, Wiza and Kihn",
      "PersonId": 536,
      "PersonName": "Konopelski-Rice",
      "AssociateId": 691,
      "Address": "quasi",
      "EmailId": 355,
      "DuplicatePersonIds": [
        379,
        225
      ],
      "Name": "Gerhold, Wolff and Collier",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 96
        }
      }
    }
  ],
  "Bcc": [
    {
      "ContactId": 714,
      "ContactName": "Padberg Group",
      "PersonId": 701,
      "PersonName": "Block Inc and Sons",
      "AssociateId": 264,
      "Address": "in",
      "EmailId": 829,
      "DuplicatePersonIds": [
        512,
        626
      ],
      "Name": "Leuschke-Dibbert",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 709
        }
      }
    }
  ],
  "Subject": "voluptatem",
  "HTMLBody": "eum",
  "From": null,
  "Sent": "2023-02-02T02:30:47.3194579+01:00",
  "Size": 997,
  "Priority": "High",
  "Flags": "Answered",
  "MessageID": "iusto",
  "PlainBody": "id",
  "IsSent": false,
  "EMailSOInfo": null,
  "ServerId": 826,
  "Attachments": [
    {
      "Description": "Extended dedicated encoding",
      "Filename": "optio",
      "Size": 807,
      "Type": "voluptate",
      "Encoding": "magni",
      "Id": "voluptates",
      "Disposition": "illum",
      "IsSafeFileExtension": false,
      "Stream": "GIF89....File contents as raw bytes...",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 664
        }
      }
    }
  ],
  "CustomHeaderList": [
    {
      "Name": "Mosciski, Mosciski and Blanda",
      "Values": [
        "tempore",
        "pariatur"
      ],
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 747
        }
      }
    },
    {
      "Name": "Mosciski, Mosciski and Blanda",
      "Values": [
        "tempore",
        "pariatur"
      ],
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 747
        }
      }
    }
  ],
  "FolderName": "Schmeler, Keebler and Kuvalis",
  "EmailItemId": 14,
  "AccountId": 584,
  "ReceivedAt": "2025-09-16T02:30:47.3194579+02:00",
  "InReplyTo": null,
  "RepliedAt": "2016-03-12T02:30:47.3194579+01:00",
  "HasCalendarData": false,
  "CalMethod": "Add",
  "CalReplyStatus": "Accepted",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 928
    }
  }
}