Get Conversation Groups

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

:::note In Beta Phase
This feature is in the Beta phase. If you have any questions, ideas or suggestions please reach out to us at devrelations@symbl.ai.
:::

This API allows you to fetch a Conversation Group.

To fetch multiple Conversation Groups, go to Get Multiple Conversation Groups section below.

API Endpoint #

Make a GET request to the following API:

GET https://api.symbl.ai/v1/manage/group/{groupId}

Request Headers #

Header Name	Required	Description
Authorization	Mandatory	Bearer <token> The token you get from our authentication process.
Content-Type	Mandatory	application/json
x-api-key	Optional	DEPRECATED. The JWT token you get from our authentication process.

Path Parameters #

Parameter	Required	Description
groupId	Mandatory	Unique ID of the group created using Management API’s Create Group API endpoint.

Response Body #

The requested Group object is returned in the response body.

{
    "group": {
        "id": "4931769134481408",
        "name": "Calls made by John",
        "description": "All the conversations made by the agent John Doe are captured in this Group.",
        "criteria": "conversation.metadata.agentId==johndoe"
    }
}

Get Multiple Conversation Groups #

To get multiple Conversation Groups in a single call, make a GET request to the following API endpoint:

API Endpoint #

GET https://api.symbl.ai/v1/manage/groups

:::info
While working with multiple Conversation Groups, notice the use of plural groups versus group used in singular Conversation Group operations.
:::