INintheloop
User

Get user contact.

get/api/v1/user/{id}

Request

  • Base URL
    https://api.intheloop.io
  • Auth
    API key in header Authorization

Path parameters

idstring required

User id (leave empty, if you want to get self - authorized user)

Query parameters

authorizedCardIdstring

Card id where user can see contact but doesn't actually have contact with him/her

Headers

Authorizationstring

Authorization header

X-Impersonate-Userstring

Impersonation header

Response

OK

idstring

Resource id

namestring

Resource name or title

revisionstring

Resource revision

clientIdstring

Resource client id

$typestring required
weightnumber

Usage weight.

createdstring date-time

Date time of contact creation

modifiedstring date-time

Date time of last time contact was modified

userIdentificatorstring

User's Identificator for EmailUser is email for phone is telephone, ....

userType'EmailUser' | 'ViberUser' | 'MessengerUser' | 'WhatsappUser' | 'PhoneUser' required

User types

emailstring

User's email address

firstNamestring

User's first name

lastNamestring

User's last name

onlineStatusstring

Online status (possible values can be seen at enums/UserStatus)

lastActivityAtstring date-time

Date time of the user's last activity

displayNamestring

User's display name, set only for senders and should be displayed per comment, mostly nullable

changableDisplayNameboolean

ChangableDisplayName indicates that user has changable name (example github notification user)

Changes

No recorded changes to this operation across all 1 revision of this API.