Get Email

This API operation gets the email of the authenticated user.

URL / Endpoint

GET /v1/Email/GetEmail

GET /v1/Groups/Email/GetEmail (See Group manager)

Request

Property	Type	Description
`EmailID`	integer	Required. The ID of the email.

Group manager

If the authenticated user is the manager of a group, the user can impersonate another member of the group. This allows the manager to perform tasks of other group members without having to authenticate as them.

The request can be build in the same way as the regular request, but targeted towards the Group manager endpoint. Additionally, it has the following extra parameters:

Property	Type	Description
`UserID`	integer	Required. The ID of a member in the group that will be impersonated for this request.

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP GET method by passing parameters over the query string of the URI.

Headers

The REST API uses HTTP request headers to determine what data type is returned or to authenticate the developer's API key. More information can be found in the overview section.

Authentication

An Authorization header is required with every request and must contain the access_token of the user. More information can be found in the Access tokens page.

Scopes

This endpoint requires the following scope:

Scope
`account_communications`

Samples

GET method

https://api-sandbox.adultwork.com/v1/Email/GetEmail
?EmailID=1

Authorization: bearer {your-access-token}

GET as Group manager

https://api-sandbox.adultwork.com/v1/Groups/Email/GetEmail
?UserID=123456 &EmailID=1

Authorization: bearer {your-access-token}

Response

Property	Type	Description
`EmailID`	integer	The ID of the email.
`Read`	integer	Indicates if this email has been read.
`Subject`	string	The subject of the email.
`Body`	string	The body of the email.
`SentDate`	datetime	The date when this email has been sent.
`OtherUserID`	integer	The ID of the user who have sent the email.
`OtherNickname`	string	The nickname of the user who have sent the email.
`OtherRatings`	aws:ProfileRatings	The member's AdultWork.com Ratings score in detail.
`OtherLogins`	integer	The amount of other logins the user who have sent the email has.
`OtherHasNegativeAlias`	boolean	Indicates if the other login of the user who have sent the email has a negative alias.
`FolderID`	integer	The ID of the folder the email is currently in.
`Disclaimer`	string	The disclaimer of AdultWork.com which needs to be displayed below the body.

Response Sample

The following example shows a sample returned by the API.

JSON
XML

{
    "EmailID": 1,
    "Read": false,
    "Subject": "The subject",
    "Body": "The body",
    "SentDate": "2017-09-01T14:09:02.11",
    "OtherUserID": 123457,
    "OtherNickname": "SendingUser",
    "OtherRatings": {
        "Total": 0,
        "Positive": 0,
        "Neutral": 0,
        "Negative": 0,
        "Ratings": 0,
        "Disputes": 0
    },
    "OtherLogins": 0,
    "OtherHasNegativeAlias": false,
    "FolderID": 0,
    "Disclaimer": "Any money paid to the adult escorts listed on this website is for their time and companionship only. Whatever else that may occur if and when contact is made is the choice of consenting adults."        
}

<Email xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Emails">
    <Body>The body</Body>
    <Disclaimer>Any money paid to the adult escorts listed on this website is for their time and companionship only. Whatever else that may occur if and when contact is made is the choice of consenting adults.</Disclaimer>
    <EmailID>1</EmailID>
    <FolderID>0</FolderID>
    <OtherHasNegativeAlias>false</OtherHasNegativeAlias>
    <OtherLogins>0</OtherLogins>
    <OtherNickname>SendingUser</OtherNickname>
    <OtherRatings xmlns:d4p1="http://schemas.datacontract.org/2004/07/API.Models.Profile">
        <d4p1:Disputes>0</d4p1:Disputes>
        <d4p1:Negative>0</d4p1:Negative>
        <d4p1:Neutral>0</d4p1:Neutral>
        <d4p1:Positive>0</d4p1:Positive>
        <d4p1:Ratings>0</d4p1:Ratings>
        <d4p1:Total>0</d4p1:Total>
    </OtherRatings>
    <OtherUserID>123457</OtherUserID>
    <Read>false</Read>
    <SentDate>2017-09-01T14:09:02.11</SentDate>
    <Subject>The subject</Subject>
</Email>