API v1 ReferenceUsers

Returns the contact infos of the user with the specified id.

Returns the contact infos of the user with the specified id. <Check><b>Required Permissions</b>: The user must have either Admin, Owner (for their own user), or UserMasterData feature with Read permission.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

userIdstringRequiredformat: "uuid"
The id of the user.

Query parameters

pageintegerOptionalDefaults to 1
Page number for pagination
pageSizeintegerOptionalDefaults to 10
Number of items per page
orderbystringOptional
The properties to order by
filterbystringOptional
The filter expression to filter by

Response

OK
labelstring or null>=0 characters<=1000 characters
The label of the contact info. Only necessary if type 'custom' is used.
valuestring or null>=0 characters<=1000 characters
The value of the contact info.
typestring or null>=0 characters<=25 characters

The type of the contact info. Possible values are: phone, email, address, messenger, social, urls.

subTypestring or null>=0 characters<=25 characters
The subtype of the contact info, Possible values are: Phone: [ 'work', 'mobile', 'home', 'work Fax', 'fax', 'other' ] Email: [ 'work', 'private', 'other' ] address: [ 'work', 'home', 'other' ] Messenger: [ 'skype', 'whatsapp', 'other' ] social: [ 'facebook', 'twitter', 'xing', 'linkedIn', 'instagram', 'pinterest', 'other' ] urls: [ 'work', 'private', 'gitHub', 'other' ].
addressLine1string or null>=0 characters<=1000 characters
The first Address line of the address.
addressLine2string or null>=0 characters<=100 characters
The second address line of the contact info.
zipCodestring or null>=0 characters<=100 characters
The Zipcode of the contact info.
citystring or null>=0 characters<=100 characters
The city of the contact info.
statestring or null>=0 characters<=100 characters
The state of the contact info.
countrystring or null>=0 characters<=100 characters
The 2 letter iso code of the country.
isAddressboolean or null
Flags whether this contactinfo is an address or not. If its an address, the address fields are required.
idstring or nullformat: "uuid"
The Id of the contact info.
isDeletedboolean or null
Whether the user has been deleted.
createdOnstring or nullformat: "date-time"
The creation date.
createdBystring or nullformat: "uuid"
The id of the user who created the entity.
updatedOnstring or nullformat: "date-time"
The date when the entity was updated.
updatedBystring or nullformat: "uuid"
the id of the user who updated the entity.