Webex · Schema

UserDetailsRequestDTO

Get User Details by list of user ids payload

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
userIds array The list of user identifiers to retrieve details for.
search string Text used to search for users (e.g., by firstName, lastName or email of the user). If provided, `queueId` is **required**. Cannot be used in combination with `userIds`.
queueId string Agent Based Queue ID to filter users . Required if `search` is provided. Cannot be used with `userIds`.
View JSON Schema on GitHub

JSON Schema

webex-userdetailsrequestdto-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserDetailsRequestDTO",
  "title": "UserDetailsRequestDTO",
  "type": "object",
  "description": "Get User Details by list of  user ids payload",
  "properties": {
    "userIds": {
      "type": "array",
      "items": {
        "example": "a1b2c3d4-e5f6-7g8h-9i10-j11k12l13m14",
        "description": "A user identifier."
      },
      "description": "The list of user identifiers to retrieve details for."
    },
    "search": {
      "type": "string",
      "description": "Text used to search for users (e.g., by firstName, lastName or email of the user).\nIf provided, `queueId` is **required**.\nCannot be used in combination with `userIds`.\n",
      "example": "john"
    },
    "queueId": {
      "type": "string",
      "description": "Agent Based Queue ID to filter users .\nRequired if `search` is provided.\nCannot be used with `userIds`.\n",
      "example": "c0ffee12-3456-abcd-7890-deadbeef1234"
    }
  }
}