---
title: "List All Identities"
method: GET
path: "/cx/social-messaging/v1/identities"
tags: ["Identities"]
---

# List All Identities

`GET /cx/social-messaging/v1/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.

## Query parameters

- `sourceId` string
- `identityGroupIds` string[]
- `userId` string
- `uuid` string
- `orderBy` '-creationTime' | '+creationTime' | 'creationTime' — Ordering by creationTime is descending by default.
- `pageToken` string
- `perPage` integer

## Response `200`

Successful response.

- IdentitiesList
  - `records` IdentityModel[], required
    - `id` string, required — Identity identifier.
    - `avatarUri` string, uri — Identity's avatar Uri.
    - `company` string — Company.
    - `creationTime` string, date-time, required — Creation time of the resource.
    - `displayName` string — Display name of the identity.
    - `emailAddress` string, email — Email address.
    - `extraValues` IdentityExtraValues — Additional data to store along the identity.
    - `firstName` string — FirstName.
    - `gender` 'Man' | 'Woman', nullable — Gender.
    - `homePhone` string — Phone number.
    - `identityGroupId` string — 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.
    - `lastName` string — LastName.
    - `mobilePhone` string — Phone number.
    - `screenName` string — Screen name of the identity.
    - `type` 'AppleMessagesForBusiness' | 'Email' | 'EngageMessaging' | 'Facebook' | 'GoogleBusinessMessages' | 'GoogleMyBusiness' | 'Instagram' | 'Linkedin' | 'Twitter' | 'Viber' | 'WhatsApp' | 'Youtube', required — Type of the identity.
    - `lastModifiedTime` string, date-time, required — The time when the last modification was completed.
    - `userIds` string[] — List of the associated user identifiers who can use the identity.
    - `uuid` string — UUID of the identity.
    - `mobileDeviceInfo` string — Device info of the identity. Applicable to RingCX Digital Messaging channels only.
    - `fbBio` string — Facebook biography of the identity. Applicable to Facebook and Messenger channels only.
    - `fbCategory` string — Facebook category of the identity. Applicable to Facebook and Messenger channels only.
    - `fbLocale` string — Facebook locale of the identity. Applicable to Facebook and Messenger channels only.
    - `igFollowersCount` integer — Instagram followers count of the identity. Applicable to Instagram and InstagramMessaging channels only.
    - `twDescription` string — Twitter description of the identity. Applicable to Twitter channels only.
    - `twFollowersCount` integer — Twitter followers count of the identity. Applicable to Twitter channels only.
    - `twFollowingCount` integer — Count of Twitter accounts followed by the identity. Applicable to Twitter channels only.
    - `twStatusesCount` integer — Count of tweets of the identity. Applicable to Twitter channels only.
    - `twLocation` string — Twitter location of the identity. Applicable to Twitter channels only.
    - `apiVersion` string — Viber API version of the identity. Applicable to Viber channels only.
    - `country` string — Viber country of the identity. Applicable to Viber channels only.
    - `deviceType` string — Viber device type of the identity. Applicable to Viber channels only.
    - `language` string — Viber language of the identity. Applicable to Viber channels only.
    - `mcc` string — Viber mobile country code of the identity. Applicable to Viber channels only.
    - `mnc` string — Viber mobile network code of the identity. Applicable to Viber channels only.
    - `primaryDeviceOs` string — Viber primary device OS of the identity. Applicable to Viber channels only.
    - `viberVersion` string — Viber application version of the identity. Applicable to Viber channels only.
  - `paging` NonEnumeratedPagingModel, required
    - `perPage` integer, required — Current page size, describes how many items are in each page. Matches "perPage" parameter from the request.
    - `pageToken` string — Current page token. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)
    - `nextPageToken` string — A page token to be used to fetch the next page of the result set. May be omitted if the current page is the last one.
    - `previousPageToken` string — A page token to be used to fetch the previous page of the result set. May be omitted if the current page is the first one or if the result set does not support backward navigation.
    - `firstPageToken` string — A page token to be used to fetch the first page of the result set.

## Other responses

- `400` — Error 400 on Identity search

---

[API](https://skmtc.net/ringcentral/apis/ringcentral-api.md) · [All operations](https://skmtc.net/ringcentral/apis/ringcentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringcentral/ringcentral-api/revisions/8d602198ec97/schema)