Sign in

v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
Identities

Get Identity

Renders an identity from given id.

get/cx/social-messaging/v1/identities/{identityId}

Path parameters

identityIdstring required

Identity identifier.

Example:506d9e817aa58d1259000f12

Response

Successful response.

idstring required

Identity identifier.

avatarUristring uri

Identity's avatar Uri.

companystring

Company.

creationTimestring date-time required

Creation time of the resource.

displayNamestring

Display name of the identity.

emailAddressstring email

Email address.

extraValuesIdentityExtraValues

Additional data to store along the identity.

firstNamestring

FirstName.

gender'Man' | 'Woman' nullable

Gender.

homePhonestring

Phone number.

identityGroupIdstring

The identity group id references the identity group that contains all information (phone, notes, etc.). Many identities may belong to this group. If the identity group id is null, it means that identity does not have a group and any extra information.

lastNamestring

LastName.

mobilePhonestring

Phone number.

screenNamestring

Screen name of the identity.

type'AppleMessagesForBusiness' | 'Email' | 'EngageMessaging' | 'Facebook' | 'GoogleBusinessMessages' | 'GoogleMyBusiness' | 'Instagram' | 'Linkedin' | 'Twitter' | 'Viber' | 'WhatsApp' | 'Youtube' required

Type of the identity.

lastModifiedTimestring date-time required

The time when the last modification was completed.

userIdsstring[]

List of the associated user identifiers who can use the identity.

uuidstring

UUID of the identity.

mobileDeviceInfostring

Device info of the identity.

Applicable to RingCX Digital Messaging channels only.

fbBiostring

Facebook biography of the identity.

Applicable to Facebook and Messenger channels only.

fbCategorystring

Facebook category of the identity.

Applicable to Facebook and Messenger channels only.

fbLocalestring

Facebook locale of the identity.

Applicable to Facebook and Messenger channels only.

igFollowersCountinteger

Instagram followers count of the identity.

Applicable to Instagram and InstagramMessaging channels only.

twDescriptionstring

Twitter description of the identity.

Applicable to Twitter channels only.

twFollowersCountinteger

Twitter followers count of the identity.

Applicable to Twitter channels only.

twFollowingCountinteger

Count of Twitter accounts followed by the identity.

Applicable to Twitter channels only.

twStatusesCountinteger

Count of tweets of the identity.

Applicable to Twitter channels only.

twLocationstring

Twitter location of the identity.

Applicable to Twitter channels only.

apiVersionstring

Viber API version of the identity.

Applicable to Viber channels only.

countrystring

Viber country of the identity.

Applicable to Viber channels only.

deviceTypestring

Viber device type of the identity.

Applicable to Viber channels only.

languagestring

Viber language of the identity.

Applicable to Viber channels only.

mccstring

Viber mobile country code of the identity.

Applicable to Viber channels only.

mncstring

Viber mobile network code of the identity.

Applicable to Viber channels only.

primaryDeviceOsstring

Viber primary device OS of the identity.

Applicable to Viber channels only.

viberVersionstring

Viber application version of the identity.

Applicable to Viber channels only.

Example response

{
  "id": "506d9e817aa58d1259000f12",
  "avatarUri": "https://example.com/assets/avatar/default-79fd530c58c2a6b83a11fcc0e842ed7023ceb69292cfeb857bc2af2c624b90fd.png",
  "company": "Test Company",
  "creationTime": "2023-02-04T12:43:07Z",
  "displayName": "John Doe",
  "emailAddress": "user@example.com",
  "extraValues": {
    "key": "value"
  },
  "firstName": "John",
  "gender": "Woman",
  "homePhone": "+33634231224",
  "identityGroupId": "54085e5b7aa58d8b5d00006c",
  "lastName": "Doe",
  "mobilePhone": "+33634231224",
  "screenName": "John D.",
  "lastModifiedTime": "2023-02-04T12:43:07Z",
  "userIds": [
    "54085e5b7aa58d8b5d00006c"
  ],
  "uuid": "9680ab94-3b78-495c-bb2c-a969954d8260",
  "mobileDeviceInfo": "iPhone (iPhone); iOS 15.0.2",
  "fbBio": "Painter living in Paris",
  "fbCategory": "Computers/Internet",
  "fbLocale": "fr_FR",
  "igFollowersCount": 10,
  "twDescription": "Software Engineer",
  "twFollowersCount": 10,
  "twFollowingCount": 500,
  "twStatusesCount": 42,
  "twLocation": "Paris",
  "apiVersion": "10",
  "country": "FR",
  "deviceType": "SM-G970U1",
  "language": "fr-FR",
  "mcc": "1",
  "mnc": "220",
  "primaryDeviceOs": "Android 11",
  "viberVersion": "19.5.0"
}