v1

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

Identities

List All Identities

List identities by creation date. The default order is descending.

The account context of this request is determined by the RC Account Id associated with the access token provided in the Authorization header.

The query parameters provided shall be considered an AND operation to filter the list.

A query parameter not specified or a query parameter provided with no value is treated as not required for filtering the list.

get/cx/social-messaging/v1/identities

Query parameters

sourceIdstring

Filter based on the specified sourceId.

identityGroupIdsstring[]

Filter based on the specified identityGroupIds (separated by commas).

userIdstring

Filter based on the specified userId.

uuidstring

Filter based on the specified uuid.

orderBy'-creationTime' | '+creationTime' | 'creationTime'

Ordering by creationTime is descending by default.

Example:+creationTime

Order results by specified field.

pageTokenstring

The token indicating the particular page of the result set to be retrieved. If omitted the first page will be returned.

perPageinteger

The number of items per page. If provided value in the request is greater than a maximum, the maximum value is applied

Response

Successful response.

Example response

{
  "records": [
    {
      "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"
    }
  ],
  "paging": {
    "perPage": 50
  }
}