Skip to main content

GET All Conversations


This API returns all conversations and allows you to add query parameters for sorting, ordering, etc. in the fetched results.

See the complete list of supported query parameters in the Query Parameters section below.

API Request#

GET https://api.symbl.ai/v1/conversations

Example API Call#

info

Before using the Conversation API, you must get the authentication token (AUTH_TOKEN) from our authentication process.

curl "https://api.symbl.ai/v1/conversations" \
-H "Authorization: Bearer $AUTH_TOKEN"

Request Body#

Given below is an example of the request along with optional query parameters. For a complete list of query parameters and their description, see the table below.

GET https://api.symbl.ai/v1/conversations?limit=2&order=desc&sort=conversation.name&offset=2&startTime=2021-08-09T18:30:00.000Z&endTime=2021-08-13T18:30:00.000Z

Query Parameters#

Following are the optional query parameters that you can pass in this API:

ParameterData TypeDescriptionRequiredDefault Value
limitInteger (int16)Specifies a non-negative integer count, to indicate that no more than count items in the result will be returned. limit set to 0 returns 0 items in the result.Optional20.
Value accepted is between 0 to 65536
offsetInteger (int16)Specifies a non-negative number of items to skip before applying limit.Optional0
orderString / enumSpecifies the order in which the results should be sorted. The order is applied on the startTime field of the associated Conversation entity.Optionalasc. Values accepted are asc and desc.
startTimeString / ISO 8601 date formatSpecifies the start of the datetime range for the results to be returned. This startTime is associated with the startTime field of the associated Conversation entity. If startTime is not mentioned, then startTime is calculated as - startTime = endTime - duration('7 days').OptionalstartTime = endTime - duration('7 days'). Values accepted are ISO 8601 formatted strings with value less than current timestamp and less than endTime.
endTimeString / ISO 8601 date formatSpecifies the end of the date time range for the results to be returned. This endTime is associated with the endTime field of the associated Conversation entity. If endTime is not mentioned, then the current timestamp is considered as endTime automatically.OptionalendTime = currentDatetime(). Values accepted are ISO 8601 formatted strings with value less than current timestamp and greater than startTime.
sortStringSpecifies one or more fields to be used to sort the results.Optionalconversation.startTime
filterString / RSQL formatSpecifies a filter string in RSQL format to filter the results.
- Filter parameter should be a valid RSQL string however it can't have OR logical Operator.
- Filter parameter can not have more than 2 parameters in it's filters. There is no limit on filters though, so user can add any number of filters using maximum of two parameters.
Optionalconversation.startDate <= {currentTimestamp - 7 days}.
note

When no filter is provided, it falls back to the default criteria of startTime and endTime.

Response#

{
"conversations": [
{
"id": "4866329603473408"
"type": "meeting",
"name": "John / Mary Brainstorming",
"startTime": "2021-02-27T15:53:05.594Z",
"endTime": "2021-02-27T16:18:05.048Z",
"members": [
{
"name": "John",
"email": "john@example.com"
},
{
"name": "Mary",
"email": "mary@example.com"
}
],
"metadata": {
"key": "value",
"agentId": "johndoe"
}
},
{
"id": "4931769134481408",
"type": "meeting",
"name": "John / Mary Catch up",
"startTime": "2021-02-24T15:53:05.594Z",
"endTime": "2021-02-24T16:18:05.048Z",
"members": [],
"metadata": {
"agentId": "johndoe"
}
},
{
"id": "6866329803473407"
"type": "meeting",
"name": "John / Acme Corp Meeting",
"startTime": "2021-02-27T15:53:05.594Z",
"endTime": "2021-02-27T16:18:05.048Z",
"members": [],
"metadata": {
"customerId": "889988999",
"agentId": "johndoe"
}
},
...
]
}

Response Object#

FieldDescription
idThe unique conversation identifier.
typeThe conversation type. Default value is meeting.
nameThe name of the conversation.
startTimeDateTime value of when the conversation started.
endTimeDateTime value of when the conversation ended.
membersA list of member objects containing ID, name and email (if detected).