List Emails
Returns all Emails available in the user's ForceManager implementation database.
You will only receive the List of Emails after first providing the Session Key. TTo know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
REQUEST
You can apply filters, organise and choose the language and pagination using any query string parameter in SQL. Query string parameters appear after a question mark in the endpoint followed by the parameters and their values. In the query string, each parameter is listed one right after the other with an AND separating them. The order of the parameters does not matter.
| Parameter | Type | Description |
|---|---|---|
| page | Integer | Define the pagination data for the returned objects |
| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |
| order | String | organise and view the results for a specific attribute in descendent order - at the top the most recent results while the oldest results will be down the list |
| lang | String | Define the language in which you want to receive the response |
You can define the pagination data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.
e.g.
https://api.forcemanager.com/api/v4/emails?page=PAGE_NUMBER
You can apply filters.
e.g.
https://api.forcemanager.com/api/v4/emails?where= param1=value AND/OR param2=value2
You can filter Emails by emailFrom or emailTo for example.
You can also organise and view the results for Emails in descendent order - at the top, the most recent results while the oldest results will be down the list.
e.g.
https://api.forcemanager.com/api/v4/emails?order=VALUE
In the request, and using query string parameters, you can also define the language in which you want to receive the response.
e.g.
https://api.forcemanager.com/api/v4/emails?lang=VALUE
RESPONSE
This endpoint returns information about all Emails available in the database.
If you didn't apply any page or count number in the header the default number of records in the response is 50.
List of the supported Emails attributes:
| Attribute | Type | Description |
|---|---|---|
| accountId | Object, Null | Account to which the Email is linked to |
| attachments | Object (Array), Null | Attachment's lists |
| body | String | Email's content |
| contactId | Object, Null | Contact to which the Email is linked to |
| date | Object | JSONObject with the time, timestamp and timeZone attributes |
| dateCreated | String | Date and time when the Email was created |
| dateDeleted | String | Date and time when the Email was deleted |
| dateUpdated | String | Date and time when the Email was last updated |
| deleted | Boolean | If true, the Email has been deleted and archived |
| emailFrom | String | Email of the person who's sending the email |
| emailTo | Array | List of Emails, that will receive the mail |
| extId | String | External ID of the Email from a third party system (ERP, CRM, Accounting System) |
| id | Integer | Unique identifier for the Email in ForceManager |
| mailFolder | String | Folder to which the mail belongs. (For example: Inbox) |
| opportunityId | Object, Null | Opportunity to which the Email is linked to |
| salesRepId | Object, Null | Id of the User responsible for the Email |
| salesRepIdCreated | Integer | Unique identifier of the User who created the Email |
| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Email |
| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Email |
| subject | String | Email's subject |
| type | Integer | 0 -> outgoing email and 1 -> incoming email |
List of the supported Attachments attributes:
| Attribute | Type | Description |
|---|---|---|
| id | Integer | Unique identifier for the Attachment in ForceManager |
| name | String | Attachment name (include the file type (.pdf, xls...)) |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/emails
- Auth: API key in header X-Session-Key
Headers
Response
List Emails
Changes
No recorded changes to this operation across all 1 revision of this API.