API

RamBase REST APIs

GET collaboration/contacts/{contactId}

Contact details for the provided identifier

HTTP method GET
URI https://api.rambase.net/collaboration/contacts/{contactId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {contactId} Contact identifier
Integer, minimum 10000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 160, version 39

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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

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

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

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

Contact identifier

>{Integer}</ContactId>
3
     <CreatedAt
CreatedAt

Date and time of creation

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

Date and time of update

>{Datetime}</UpdatedAt>
5
     <Status
Status

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

Possible domain values can be found here

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

Firstname/givenname of the contact

>{String}</FirstName>
7
     <LastName
LastName

Surname/familyname/lastname of the contact

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

Professional title

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

Privileges to external applications for contact

Possible domain values can be found here

>{String}</ExternalPrivileges>
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=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=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=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=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=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=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=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=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=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=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=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=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
          <HasMarketingConsent
HasMarketingConsent

Consent to marketing. Yes or no value.

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

The legal basis for processing contact's data

Possible domain values can be found here

>{Integer}</LegalBasisForDataProcessing>
31
     </Privacy>
32
</Contact>
1
{
2
     "contact": {
3
          "contactId
ContactId

Contact identifier

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

Date and time of creation

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

Date and time of update

": "{Datetime}",
6
          "status
Status

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

Possible domain values can be found here

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

Firstname/givenname of the contact

": "{String}",
8
          "lastName
LastName

Surname/familyname/lastname of the contact

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

Professional title

": "{String}",
10
          "externalPrivileges
ExternalPrivileges

Privileges to external applications for contact

Possible domain values can be found here

": "{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=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=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=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=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=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=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=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=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=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=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=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=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
               "hasMarketingConsent
HasMarketingConsent

Consent to marketing. Yes or no value.

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

The legal basis for processing contact's data

Possible domain values can be found here

": "{Integer}"
32
          }
33
     }
34
}

Possible error codes the response might return:

Error 100052 HTTP 403 You only have admittance to your own contacts