API

RamBase REST APIs

GET collaboration/contacts

List of contacts

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

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.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$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"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$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.

Active() Named filter Active contacts
Inactive() Named filter Inactive contacts
ReferencedByCustomer() Named filter Contacts referenced by customer
ReferencedByPerson() Named filter Contacts referenced by person
ReferencedBySupplier() Named filter Contacts referenced by supplier
Category String Category of the contact.
ContactId Integer Contact identifier.
FirstName String Firstname/givenname of the contact.
HasAcceptedPrivacyPolicy Boolean Privacy policy accepted. Yes or no value.
HasMarketingConsent Boolean Consent to marketing. Yes or no value.
JobTitle String Professional title.
LastName String Surname/familyname/lastname of the contact.
LegalBasisForDataProcessing Integer The legal basis for processing contact's data.
PreferredLanguage String Three character code following the ISO 639-2 standard.
ReferencedBy String Filter contacts by references.
ReferencedCustomerId String Filter contacts by customerid.
ReferencedSupplierId String Filter contacts by supplierid.
Source Integer Source of which the personal information was obtained.
Status Integer Status of the contact. 1:New, 4:Active, 9:Inactive.
UpdatedAt Datetime Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()

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

Category String Category of the contact
ContactId Integer Contact identifier
FirstName String Firstname/givenname of the contact
HasAcceptedPrivacyPolicy Boolean Privacy policy accepted. Yes or no value.
HasMarketingConsent Boolean Consent to marketing. Yes or no value.
JobTitle String Professional title
LastName String Surname/familyname/lastname of the contact
LegalBasisForDataProcessing Integer The legal basis for processing contact's data
PreferredLanguage String Three character code following the ISO 639-2 standard.
Source Integer Source of which the personal information was obtained
Status Integer Status of the contact. 1:New, 4:Active, 9:Inactive
UpdatedAt Datetime Date and time of update

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
<Contacts>
2
     <Contact>
3
          <ContactId
ContactId

Contact identifier

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

Status of the contact. 1:New, 4:Active, 9:Inactive

Possible domain values can be found here

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

Firstname/givenname of the contact

>{String}</FirstName>
6
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
7
          <UpdatedAt
UpdatedAt

Date and time of update

>{Datetime}</UpdatedAt>
8
          <LastName
LastName

Surname/familyname/lastname of the contact

>{String}</LastName>
9
          <JobTitle
JobTitle

Professional title

>{String}</JobTitle>
10
          <PreferredLanguage
PreferredLanguage

Three character code following the ISO 639-2 standard.

Possible domain values can be found here

>{String}</PreferredLanguage>
11
          <Category
Category

Category of the contact

Possible domain values can be found here

>{String}</Category>
12
          <Source
Source

Source of which the personal information was obtained

Possible domain values can be found here

>{Integer}</Source>
13
          <DefaultEmail
DefaultEmail

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

>
14
               <EmailId
EmailId

Email identifier

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

>{Integer}</EmailId>
15
               <CreatedAt
CreatedAt

Date and time of creation

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

>{Datetime}</CreatedAt>
16
               <Type
Type

Type of email

Possible domain values can be found here

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

>{String}</Type>
17
               <Address
Address

The email address

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

>{String}</Address>
18
               <EmailLink
EmailLink

Email reference

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

>{String}</EmailLink>
19
          </DefaultEmail>
20
          <DefaultPhone
DefaultPhone

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

>
21
               <PhoneId
PhoneId

Phone identifier

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

>{Integer}</PhoneId>
22
               <PhoneNumber
PhoneNumber

The phone number

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

>{String}</PhoneNumber>
23
               <Type
Type

Type of phone

Possible domain values can be found here

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

>{String}</Type>
24
               <CreatedAt
CreatedAt

Date and time of creation

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

>{Datetime}</CreatedAt>
25
               <PhoneLink
PhoneLink

Phone reference

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

>{String}</PhoneLink>
26
          </DefaultPhone>
27
          <Privacy>
28
               <HasAcceptedPrivacyPolicy
HasAcceptedPrivacyPolicy

Privacy policy accepted. Yes or no value.

>{Boolean}</HasAcceptedPrivacyPolicy>
29
               <LegalBasisForDataProcessing
LegalBasisForDataProcessing

The legal basis for processing contact's data

Possible domain values can be found here

>{Integer}</LegalBasisForDataProcessing>
30
               <HasMarketingConsent
HasMarketingConsent

Consent to marketing. Yes or no value.

>{Boolean}</HasMarketingConsent>
31
          </Privacy>
32
          <ContactLink
ContactLink

Contact reference

>{String}</ContactLink>
33
     </Contact>
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}</PageSize>
36
          <Position
Position

Position of the first element in the list

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

Page index

>{Integer}</Page>
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}</FirstPageKey>
39
          <FirstPage
FirstPage

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

>{String}</FirstPage>
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}</PreviousPageKey>
41
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
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}</NextPageKey>
43
          <NextPage
NextPage

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

>{String}</NextPage>
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}</LastPageKey>
45
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
47
     </Paging>
48
</Contacts>
1
{
2
     "contacts": [
3
          {
4
               "contactId
ContactId

Contact identifier

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

Status of the contact. 1:New, 4:Active, 9:Inactive

Possible domain values can be found here

": "{Integer}",
6
               "firstName
FirstName

Firstname/givenname of the contact

": "{String}",
7
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
8
               "updatedAt
UpdatedAt

Date and time of update

": "{Datetime}",
9
               "lastName
LastName

Surname/familyname/lastname of the contact

": "{String}",
10
               "jobTitle
JobTitle

Professional title

": "{String}",
11
               "preferredLanguage
PreferredLanguage

Three character code following the ISO 639-2 standard.

Possible domain values can be found here

": "{String}",
12
               "category
Category

Category of the contact

Possible domain values can be found here

": "{String}",
13
               "source
Source

Source of which the personal information was obtained

Possible domain values can be found here

": "{Integer}",
14
               "defaultEmail
DefaultEmail

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

": {
15
                    "emailId
EmailId

Email identifier

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

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

Date and time of creation

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

": "{Datetime}",
17
                    "type
Type

Type of email

Possible domain values can be found here

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

": "{String}",
18
                    "address
Address

The email address

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

": "{String}",
19
                    "emailLink
EmailLink

Email reference

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

": "{String}"
20
               },
21
               "defaultPhone
DefaultPhone

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

": {
22
                    "phoneId
PhoneId

Phone identifier

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

": "{Integer}",
23
                    "phoneNumber
PhoneNumber

The phone number

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

": "{String}",
24
                    "type
Type

Type of phone

Possible domain values can be found here

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

": "{String}",
25
                    "createdAt
CreatedAt

Date and time of creation

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

": "{Datetime}",
26
                    "phoneLink
PhoneLink

Phone reference

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

": "{String}"
27
               },
28
               "privacy": {
29
                    "hasAcceptedPrivacyPolicy
HasAcceptedPrivacyPolicy

Privacy policy accepted. Yes or no value.

": "{Boolean}",
30
                    "legalBasisForDataProcessing
LegalBasisForDataProcessing

The legal basis for processing contact's data

Possible domain values can be found here

": "{Integer}",
31
                    "hasMarketingConsent
HasMarketingConsent

Consent to marketing. Yes or no value.

": "{Boolean}"
32
               },
33
               "contactLink
ContactLink

Contact reference

": "{String}"
34
          }
35
     ],
36
     "paging
Paging

Detailed paging information for this list.

": {
37
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
40
          "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}",
41
          "firstPage
FirstPage

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

": "{String}",
42
          "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}",
43
          "previousPage
PreviousPage

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

": "{String}",
44
          "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}",
45
          "nextPage
NextPage

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

": "{String}",
46
          "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}",
47
          "lastPage
LastPage

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

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

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

": "{Integer}"
49
     }
50
}

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: