Retrieve All Chat Conversations

get

https://{hostname}/api/talk/chat/v1/conversations

This operation returns all chat conversations in the system. The response may include both one-to-one and group conversations, and can be paginated using index and count.

Design Note

Conversations are implicitly created when messages are sent via the Chat Messages operation (POST /chat/v1/messages). The Chat Conversations API resource provides only GET and DELETE operations. There are no POST or PATCH operations for conversations as they are managed automatically through message creation.

Authorization and Permissions

An OpenAm or UKG Authentication token is required to retrieve conversations.

Query Params

count

integer

≤ 100

Defaults to 100

The count of a paginated response, which specifies the number of chat conversations to return per page. If not specified, a default of 100 conversations is returned. The count cannot exceed 100.

index

number

The starting offset for the paginated response, which specifies the number of records to skip before returning results. If not specified, a default of 0 is used.

sort

string

A comma-separated list of response property names by which to sort the results. By default, sorting is in ascending order. To specify descending order, append 'desc' after the property name. For example, 'sort=createdAt desc,modifiedAt' sorts by createdAt descending and then by modifiedAt ascending.

Headers

x-correlation-id

string

A UUID value to track the request, used for debugging and tracing.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200Successfully retrieved conversations list.

400The HTTP status code 400 Bad Request error, thrown when required parameters are not passed.

401The HTTP status code 401 Unauthorized error, thrown when the user is not authorized to access the resource.

403The HTTP status code 403 Forbidden error, thrown when the user is not authorized to access the resource.

405The HTTP status code 405 Method Not Allowed error, thrown when you attempt to call a URI with an unsupported HTTP method.

406The HTTP status code 406 Not Acceptable Content error, thrown when you send a request with accept header other than application/json.

413The HTTP status code 413 Payload Too Large error, thrown when you attempt to pass a request payload that exceeds the limit.

429The HTTP status code 429 Too Many Requests error, thrown when the user exceeds the allowed rate limit for the API.

500The HTTP status code 500 Internal Server error, thrown when the server is not able to process the request.