# Get conversations assigned to a specific agent (deprecated)

Deprecated. Use List chats (v2) with scope=my. v2 resolves the agent from your API key / session, so it returns your assigned chats — you can no longer query an arbitrary agent by id. Retained for existing integrations.

Retrieve all active conversations assigned to a specific agent by their user ID.

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

## Query parameters:

  - `assignedTo` (string, required)
    System user ID of the agent.
    Example: "a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890"

## Response 200 fields (application/json):

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

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

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

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

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

  - `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"

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

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

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

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

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

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

  - `conversationClosed` (boolean)

  - `missedConversation` (boolean)

  - `afterHoursConversation` (boolean)

  - `chatBotConversation` (boolean)
    Example: true

  - `sendRatingWidget` (boolean)

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

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

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

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

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

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

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

  - `assignedTo` (object)

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

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

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

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

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

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

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

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

  - `assignedTo.sentLowerCreditLimitMail` (boolean)

  - `assignedTo.sentZeroCreditMail` (boolean)

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

  - `assignedTo.disabled` (boolean)

  - `assignedTo.deleted` (boolean)

  - `assignedTo.emailVerificationKey` (string,null)

  - `assignedTo.passwordResetKey` (string,null)

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

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

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

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

  - `assignedTo.client` (object)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  - `assignedTo.client.upperNotificationLimitMailSent` (boolean)

  - `assignedTo.client.lowerNotificationLimitMailSent` (boolean)

  - `assignedTo.client.zeroBalanceNotificationMailSent` (boolean)

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

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

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

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

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

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

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

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

  - `assignedTo.client.reseller` (boolean)

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

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

  - `assignedTo.client.useParentNumber` (boolean)

  - `assignedTo.client.useParentCredit` (boolean)

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

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

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

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

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

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

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

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

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

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

  - `assignedTo.clientRef` (string,null)

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

  - `assignedTo.lastSeen` (string,null)

  - `assignedTo.resetPasswordEmailSent` (boolean)

  - `assignedTo.emailVerified` (boolean)

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

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

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

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

  - `assignedTo.initialPassword` (boolean)

  - `assignedTo.tempAccount` (boolean)

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

  - `assignedTo.validToken` (boolean)

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

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

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

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

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

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

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

  - `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."

  - `lastAssignedAgent` (object)

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

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

  - `unread` (boolean)
    Example: true

  - `rated` (boolean)

  - `expectingRating` (boolean)

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

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

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

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

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

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

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

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

## 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"