API

Collaboration APIs

GET collaboration/emails

List of all emails

HTTP method GET
URI https://api.rambase.net/collaboration/emails
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 1897, version 10

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

InboundEmails() Named filter Inbound emails
OutboundEmails() Named filter Outbound emails
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Direction String Indicates whether the relationship activity is inbound (INBOUND) or outbound (OUTBOUND)..
EmailId Integer Email identifier.
OccuredAt Datetime Date and time the relationship activity occured. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
SenderEmailAddress String Email address of the sender.
Status Integer Status of the relationship email.
Subject String Subject of the relationship email.

Read more about filters and sorting on how to use sortable parameters

CreatedAt Datetime Date and time of creation
Direction String Indicates whether the relationship activity is inbound (INBOUND) or outbound (OUTBOUND).
EmailId Integer Email identifier
OccuredAt Datetime Date and time the relationship activity occured
SenderEmailAddress String Email address of the sender
Status Integer Status of the relationship email
Subject String Subject of the relationship email

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Emails>
2
     <Email>
3
          <EmailId
EmailId

Email identifier

>{Integer}</EmailId>
4
          <Status
Status

Status of the relationship email

>{Integer}</Status>
5
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
          <OccuredAt
OccuredAt

Date and time of the relationship activity

>{Datetime}</OccuredAt>
7
          <Subject
Subject

Subject of the relationship email

>{String}</Subject>
8
          <Direction
Direction

Indicates whether the relationship activity is inbound (INBOUND) or outbound (OUTBOUND).

>{String}</Direction>
9
          <Regarding
Regarding

The customer/supplier of the relationship

>
10
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
11
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
12
               <Name
Name

Name of the customer/supplier, or last name if it is a person.

This field is greyed out because it is an expandable field. You have to add $expand=Email.Regarding.Name in your request URI to get this field

>{String}</Name>
13
               <FirstName
FirstName

First name of the customer/supplier

This field is greyed out because it is an expandable field. You have to add $expand=Email.Regarding.FirstName in your request URI to get this field

>{String}</FirstName>
14
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
15
          </Regarding>
16
          <CreatedBy
CreatedBy

All activities are assigned an owner who is responsible for completing/follow up the activity

>
17
               <UserId
UserId

User identifier

>{Integer}</UserId>
18
               <Name
Name

Name of the user

This field is greyed out because it is an expandable field. You have to add $expand=Email.CreatedBy.Name in your request URI to get this field

>{String}</Name>
19
               <FirstName
FirstName

First name of the user

This field is greyed out because it is an expandable field. You have to add $expand=Email.CreatedBy.FirstName in your request URI to get this field

>{String}</FirstName>
20
               <UserLink
UserLink

User reference

>{String}</UserLink>
21
          </CreatedBy>
22
          <Sender
Sender

Reference to the contact/supplier/employee/customer who sent the email

>
23
               <EmailAddress
EmailAddress

Email address of the sender

>{String}</EmailAddress>
24
               <Description
Description

Description of sender

>{String}</Description>
25
               <ObjectReference
ObjectReference

Reference to the contact/supplier/employee/customer who sent the email

>
26
                    <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
27
                    <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
28
                    <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
29
               </ObjectReference>
30
          </Sender>
31
     </Email>
32
     <Paging
Paging

Detailed paging information for this list.

>
33
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
34
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
35
          <Page
Page

Page index

>{Integer}</Page>
36
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
37
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
38
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
39
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
40
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
41
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
42
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
43
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
44
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
45
     </Paging>
46
</Emails>
1
{
2
     "emails": [
3
          {
4
               "emailId
EmailId

Email identifier

": "{Integer}",
5
               "status
Status

Status of the relationship email

": "{Integer}",
6
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
               "occuredAt
OccuredAt

Date and time of the relationship activity

": "{Datetime}",
8
               "subject
Subject

Subject of the relationship email

": "{String}",
9
               "direction
Direction

Indicates whether the relationship activity is inbound (INBOUND) or outbound (OUTBOUND).

": "{String}",
10
               "regarding
Regarding

The customer/supplier of the relationship

": {
11
                    "objectId
ObjectId

Identifier of the object

": "{Integer}",
12
                    "objectType
ObjectType

Type of object

": "{String}",
13
                    "name
Name

Name of the customer/supplier, or last name if it is a person.

This field is greyed out because it is an expandable field. You have to add $expand=Email.Regarding.Name in your request URI to get this field

": "{String}",
14
                    "firstName
FirstName

First name of the customer/supplier

This field is greyed out because it is an expandable field. You have to add $expand=Email.Regarding.FirstName in your request URI to get this field

": "{String}",
15
                    "objectLink
ObjectLink

API reference to the object

": "{String}"
16
               },
17
               "createdBy
CreatedBy

All activities are assigned an owner who is responsible for completing/follow up the activity

": {
18
                    "userId
UserId

User identifier

": "{Integer}",
19
                    "name
Name

Name of the user

This field is greyed out because it is an expandable field. You have to add $expand=Email.CreatedBy.Name in your request URI to get this field

": "{String}",
20
                    "firstName
FirstName

First name of the user

This field is greyed out because it is an expandable field. You have to add $expand=Email.CreatedBy.FirstName in your request URI to get this field

": "{String}",
21
                    "userLink
UserLink

User reference

": "{String}"
22
               },
23
               "sender
Sender

Reference to the contact/supplier/employee/customer who sent the email

": {
24
                    "emailAddress
EmailAddress

Email address of the sender

": "{String}",
25
                    "description
Description

Description of sender

": "{String}",
26
                    "objectReference
ObjectReference

Reference to the contact/supplier/employee/customer who sent the email

": {
27
                         "objectId
ObjectId

Identifier of the object

": "{Integer}",
28
                         "objectType
ObjectType

Type of object

": "{String}",
29
                         "objectLink
ObjectLink

API reference to the object

": "{String}"
30
                    }
31
               }
32
          }
33
     ],
34
     "paging
Paging

Detailed paging information for this list.

": {
35
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
36
          "position
Position

Position of the first element in the list

": "{Integer}",
37
          "page
Page

Page index

": "{Integer}",
38
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
39
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
40
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
41
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
42
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
43
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
44
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
45
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
46
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
47
     }
48
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100050 HTTP 403 No admittance as customer {0}