# Get chat participants (deprecated)

Deprecated. Use List chats (v2), which returns a lean ChatParticipantResponse and selects the list with a scope filter (my / team / unassigned / closed / missed / open / all). This endpoint returns the full internal entity and is retained only for existing integrations.

Retrieve chat participant details for the authenticated user's client. Returns participant profile information, assignment status, and conversation metadata. Use searchString to filter by phone number or full name, and isOpen to filter by conversation state.

Endpoint: GET /pl4chat-service/ChatParticipant
Version: 3.0.0
Security: apikeyAuth

## Query parameters:

  - `page` (integer)
    Page number (zero-based).

  - `size` (integer)
    Number of items per page.
    Example: 10

  - `searchString` (string)
    Optional case-insensitive substring filter applied to the participant's phone number and full name. Partial matches are supported. Omit to return unfiltered results.
    Example: "27123456789"

  - `isOpen` (boolean)
    Optional conversation-state filter. Omit (or send no value) to return all chats. Pass true to return only open conversations (conversationClosed = false), or false to return only closed conversations (conversationClosed = true).
    Example: true

## Response 200 fields (application/json):

  - `content` (array)

  - `content.id` (string)
    Example: "cp-a1b2c3d4"

  - `content.firstName` (string)
    Example: "John"

  - `content.lastName` (string)
    Example: "Doe"

  - `content.fullName` (string)
    Example: "John Doe"

  - `content.phoneNumber` (string)
    Example: "27821234567"

  - `content.userId` (string)
    Customer's durable business-scoped user id (BSUID, alpha usernames), e.g. ZA.1021033720668862. Stable across phone-number changes; present even when the phone is withheld.
    Example: "ZA.1021033720668862"

  - `content.username` (string)
    Customer's optional WhatsApp username (display only).
    Example: "johndoe"

  - `content.parentUserId` (string)
    BSUID of the parent WhatsApp Business portfolio, when applicable.
    Example: "ZA.1000000000000000"

  - `content.email` (string)
    Example: "john.doe@example.com"

  - `content.subject` (string)
    Example: "Billing Inquiry"

  - `content.team` (string)
    Example: "Support Team"

  - `content.whatsAppClientNumber` (string)
    Example: "+27123456789"

  - `content.conversationClosed` (boolean)

  - `content.missedConversation` (boolean)

  - `content.afterHoursConversation` (boolean)

  - `content.chatBotConversation` (boolean)
    Example: true

  - `content.sendRatingWidget` (boolean)

  - `content.clientRef` (string)
    Example: "Growthpoint"

  - `content.createdTime` (string)
    Example: "2026-01-15T08:00:00Z"

  - `content.lastMessageTime` (string)
    Example: "2026-01-15T10:35:00Z"

  - `content.customerLastMessageTime` (string,null)
    Example: "2026-01-15T10:30:00Z"

  - `content.channel` (string)
    Enum: "WHATSAPP", "WEB", "FACEBOOK"

  - `content.conversationStatus` (string)
    Example: "OPEN"

  - `content.sender` (string)
    Example: "+27821234567"

  - `content.assignedTo` (object)

  - `content.assignedTo.id` (string)
    Example: "e1f2a3b4-c5d6-7890-e1f2-a3b4c5d67890"

  - `content.assignedTo.email` (string)
    Example: "agent@example.com"

  - `content.assignedTo.password` (string)
    Example: "********"

  - `content.assignedTo.tempPassword` (string,null)
    Example: "********"

  - `content.assignedTo.role` (string)
    Enum: "CLIENT"

  - `content.assignedTo.liveChatRole` (string)
    Enum: "SUPERVISOR", "AGENT"

  - `content.assignedTo.primaryEmailAddress` (string,null)
    Example: "agent@example.com"

  - `content.assignedTo.mobileNumber` (string,null)
    Example: "+27821234567"

  - `content.assignedTo.sentLowerCreditLimitMail` (boolean)

  - `content.assignedTo.sentZeroCreditMail` (boolean)

  - `content.assignedTo.apiKey` (string)
    Example: "64a1b2c3d4e5f67890abcdef"

  - `content.assignedTo.disabled` (boolean)

  - `content.assignedTo.deleted` (boolean)

  - `content.assignedTo.emailVerificationKey` (string,null)

  - `content.assignedTo.passwordResetKey` (string,null)

  - `content.assignedTo.inactivityNodeId` (string,null)
    Example: "node-inactivity-001"

  - `content.assignedTo.publicHolidayInactivityNodeId` (string,null)
    Example: "node-holiday-001"

  - `content.assignedTo.officeClosedInactivityNodeId` (string,null)
    Example: "node-closed-001"

  - `content.assignedTo.autoResponseNodeId` (string,null)
    Example: "node-auto-001"

  - `content.assignedTo.client` (object)

  - `content.assignedTo.client.id` (string)
    Example: "dbdb8809-6fd0-4cd2-8574-502f0f61a69d"

  - `content.assignedTo.client.clientRef` (string)
    Example: "Growthpoint"

  - `content.assignedTo.client.accountType` (string)
    Example: "Postpaid"

  - `content.assignedTo.client.countryCode` (string)
    Example: "ZA"

  - `content.assignedTo.client.countryTimezone` (string)
    Example: "Africa/Johannesburg"

  - `content.assignedTo.client.pricingModel` (string)
    Example: "PMP"

  - `content.assignedTo.client.clientPlatformCharge` (number,null)
    Example: 0.1

  - `content.assignedTo.client.clientNotificationCharge` (number)
    Example: 0.35

  - `content.assignedTo.client.clientSession24HourCharge` (number)
    Example: 0.35

  - `content.assignedTo.client.clientConversationCharge` (number)
    Example: 0.35

  - `content.assignedTo.client.userInitiatedConversationCharge` (number,null)
    Example: 0.2

  - `content.assignedTo.client.businessInitiatedConversationCharge` (number)
    Example: 1.25

  - `content.assignedTo.client.clientWhatsAppBalance` (number)
    Example: 1000

  - `content.assignedTo.client.clientSMSBalance` (number)
    Example: 10

  - `content.assignedTo.client.primaryEmailAddress` (string,null)
    Example: "admin@example.com"

  - `content.assignedTo.client.secondaryEmailAddress` (string,null)
    Example: "backup@example.com"

  - `content.assignedTo.client.clientEmailAddress` (string,null)
    Example: "client@example.com"

  - `content.assignedTo.client.upperNotificationLimit` (number,null)
    Example: 100

  - `content.assignedTo.client.lowerNotificationLimit` (number,null)
    Example: 10

  - `content.assignedTo.client.upperNotificationLimitMailSent` (boolean)

  - `content.assignedTo.client.lowerNotificationLimitMailSent` (boolean)

  - `content.assignedTo.client.zeroBalanceNotificationMailSent` (boolean)

  - `content.assignedTo.client.lastUpperNotificationMailSentTime` (string,null)
    Example: "2026-01-15T10:30:00+02:00"

  - `content.assignedTo.client.lastLowerNotificationMailSentTime` (string,null)
    Example: "2026-01-20T14:00:00+02:00"

  - `content.assignedTo.client.lastZeroBalanceNotificationMailSentTime` (string,null)

  - `content.assignedTo.client.smsMode` (string)
    Example: "fallback"

  - `content.assignedTo.client.smsFallback` (boolean)
    Example: true

  - `content.assignedTo.client.smsUserId` (string)
    Example: "support@ecommunicate.co.za"

  - `content.assignedTo.client.smsPassword` (string)
    Example: "********"

  - `content.assignedTo.client.smsClientRef` (string)
    Example: "ecomtest1"

  - `content.assignedTo.client.reseller` (boolean)

  - `content.assignedTo.client.parentClient` (object,null)

  - `content.assignedTo.client.license` (object,null)

  - `content.assignedTo.client.useParentNumber` (boolean)

  - `content.assignedTo.client.useParentCredit` (boolean)

  - `content.assignedTo.client.userInitiatedConversationBalance` (number)
    Example: 100

  - `content.assignedTo.client.businessInitiatedConversationBalance` (number)
    Example: 973

  - `content.assignedTo.client.popiaComplianceEnabled` (boolean)
    Example: true

  - `content.assignedTo.client.eligible1000Free` (boolean)
    Example: true

  - `content.assignedTo.client.splitConversation` (boolean)
    Example: true

  - `content.assignedTo.client.monthlyFundAllocation` (boolean)
    Example: true

  - `content.assignedTo.client.monthlyBusinessInitiatedBalanceAllocation` (number)
    Example: 1000

  - `content.assignedTo.client.monthlyUserInitiatedBalanceAllocation` (number)
    Example: 100

  - `content.assignedTo.client.useApi` (boolean)
    Example: true

  - `content.assignedTo.client.headerKeyPairsJson` (string)
    JSON array of key-value header pairs.
    Example: "[{\"key\": \"Authorization\", \"value\": \"your-api-key\"}]"

  - `content.assignedTo.clientRef` (string,null)

  - `content.assignedTo.ticketCount` (integer,null)
    Example: 5

  - `content.assignedTo.lastSeen` (string,null)

  - `content.assignedTo.resetPasswordEmailSent` (boolean)

  - `content.assignedTo.emailVerified` (boolean)

  - `content.assignedTo.firstName` (string)
    Example: "Jane"

  - `content.assignedTo.lastName` (string)
    Example: "Doe"

  - `content.assignedTo.agentChatLimit` (integer)
    Max concurrent chats.
    Example: 5

  - `content.assignedTo.availabilityStatus` (boolean)
    Example: true

  - `content.assignedTo.initialPassword` (boolean)

  - `content.assignedTo.tempAccount` (boolean)

  - `content.assignedTo.loginToken` (string)
    Example: "1d368c30-c9f8-4523-b8c2-3824ba72ff5c"

  - `content.assignedTo.validToken` (boolean)

  - `content.assignedTo.avatar` (string)
    Example: "https://example.com/avatars/jane.jpg"

  - `content.assignedTo.shouldGetNotifications` (boolean)
    Example: true

  - `content.assignedTo.applicationKey` (string)
    Example: "a3b4c5d6-e7f8-9012-a3b4-c5d6e7f89012"

  - `content.assignedTo.userId` (string)
    Example: "21c28d3e-bc5c-4bc9-99be-fe283df71653"

  - `content.assignedTo.applicationClientId` (string)
    Example: "1d368c30-c9f8-4523-b8c2-3824ba72ff5c"

  - `content.assignedTo.allowedSharedInbox` (boolean)
    Example: true

  - `content.assignedTo.allowedUnassignedInbox` (boolean)
    Example: true

  - `content.assignedTo.assignmentMessage` (string)
    Custom message sent to the customer when a chat is assigned to this agent. If null, defaults to 'Assigned to ``'.
    Example: "Hi, I'm Jane and I'll be assisting you today."

  - `content.lastAssignedAgent` (object)

  - `content.openedBy` (string)
    Example: "agent@example.com"

  - `content.terminatedBy` (string)
    Example: "agent@example.com"

  - `content.unread` (boolean)
    Example: true

  - `content.rated` (boolean)

  - `content.expectingRating` (boolean)

  - `content.companyName` (string)
    Example: "Acme Corp"

  - `content.accountNumber` (string)
    Example: "ACC-001234"

  - `content.activeFlow` (string)
    Example: "main_support_flow"

  - `content.nodeName` (string)
    Example: "Welcome Node"

  - `content.botName` (string)
    Example: "Support Bot"

  - `content.timezone` (string)
    Example: "Africa/Johannesburg"

  - `content.gstn` (string)
    Global system tracking number
    Example: "a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890"

  - `content.ctn` (string)
    Client tracking number
    Example: "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901"

  - `totalElements` (integer)
    Example: 85

  - `totalPages` (integer)
    Example: 9

  - `size` (integer)
    Example: 10

  - `number` (integer)

  - `first` (boolean)
    Example: true

  - `last` (boolean)

  - `empty` (boolean)

## Response 401 fields (application/json):

  - `status` (string)
    Example: "ERROR"

  - `message` (string)
    Example: "Unauthorized user"

  - `requestId` (string)
    Example: "c3a1f8e2-4b6d-11ee-be56-0242ac120002"

  - `timestamp` (string)
    Example: "2026-01-15T10:30:00Z"