API Methods
Account ...
Blogs ...
Bookings ...
CreditHistory ...
Dashboard ...
DirectCam ...
DirectChat ...
Email ...
FieldReport ...
Groups ...
HotLists ...
Interview ...
Lists ...
Movie ...
Newsfeed ...
PhoneChat ...
Pictures ...
Profile ...
Search ...
Tours ...
Webcam ...

GetUnreadEmails

Use this method to get the number of unread emails of the user who is logged in via the Unified Login using the access_token.

URL / Endpoint

Need help with Postman?

GET /v1/Email/GetUnreadEmails

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

Request

PropertyTypeDescription
This operation does not accept any parameters.

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:

PropertyTypeDescription
UserID integer Required. The ID of a member in the group that will be impersonated for this request.

Request Information

HTTP Method / Verb

This endpoint is using the HTTP GET method.

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/getUnreadEmails

Authorization: bearer {your-access-token}

GET as Group manager

https://api-sandbox.adultwork.com/v1/email/getUnreadEmails
?UserID=123456

Authorization: bearer {your-access-token}

Response

PropertyTypeDescription
  integer The number of unread emails for the specified user

Response Sample

The following example returns the result.

4

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</int>