GET collaboration/contacts/{contactId}

Contact details for the provided identifier

Note: Log in to check if your API client have access to run this resource
Version: 37
Success HTTP Status Code: 200

Uri parameters

{contactId} Integer Contact identifier

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 is 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.

$expand String, optional Use to expand Output fields that are not shown by default in the output result. Possible Expandable fields are listed in the Output tab for the resource. Accepts a comma-separated list of expandable Output Field names. See the Expand and Select page for more information about this.
$showDomainDescriptions Boolean, optional Use to show an additional descriptional field for fields that are using Domain Values.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

See the page 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
     <Status
Status

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

Possible domain values can be found here when logged in

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

Firstname/givenname of the contact

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

Surname/familyname/lastname of the contact

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

Professional title

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

Privileges to external applications for contact

Possible domain values can be found here when logged in

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

Three character code following the ISO 639-2 standard.

Possible domain values can be found here when logged in

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

Category of the contact

Possible domain values can be found here when logged in

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

Source of which the personal information was obtained

Possible domain values can be found here when logged in

>
{Integer}</Source>
12
     <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

>
13
          <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>
14
          <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>
15
          <Type
Type

Type of email

Possible domain values can be found here when logged in

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>
16
          <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>
17
          <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>
18
     </DefaultEmail>
19
     <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

>
20
          <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>
21
          <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>
22
          <Type
Type

Type of phone

Possible domain values can be found here when logged in

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>
23
          <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>
24
          <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>
25
     </DefaultPhone>
26
     <Privacy>
27
          <HasAcceptedPrivacyPolicy
HasAcceptedPrivacyPolicy

Privacy policy accepted. Yes or no value.

>
{Boolean}</HasAcceptedPrivacyPolicy>
28
          <HasMarketingConsent
HasMarketingConsent

Consent to marketing. Yes or no value.

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

The legal basis for processing contact's data

Possible domain values can be found here when logged in

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

Contact identifier

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

Date and time of creation

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

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

Possible domain values can be found here when logged in

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

Firstname/givenname of the contact

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

Surname/familyname/lastname of the contact

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

Professional title

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

Privileges to external applications for contact

Possible domain values can be found here when logged in

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

Three character code following the ISO 639-2 standard.

Possible domain values can be found here when logged in

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

Category of the contact

Possible domain values can be found here when logged in

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

Source of which the personal information was obtained

Possible domain values can be found here when logged in

":
"{Integer}",
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}",
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}",
16
               "type
Type

Type of email

Possible domain values can be found here when logged in

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}",
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}",
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}"
19
          },
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}",
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}",
23
               "type
Type

Type of phone

Possible domain values can be found here when logged in

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
               "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}",
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}"
26
          },
27
          "privacy": {
28
               "hasAcceptedPrivacyPolicy
HasAcceptedPrivacyPolicy

Privacy policy accepted. Yes or no value.

":
"{Boolean}",
29
               "hasMarketingConsent
HasMarketingConsent

Consent to marketing. Yes or no value.

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

The legal basis for processing contact's data

Possible domain values can be found here when logged in

":
"{Integer}"
31
          }
32
     }
33
}

Possible error codes the response might return:

Error 100034 HTTP 404 Contact not found
Error 100052 HTTP 403 You only have admittance to your own contacts