Skip to main content
GET
List Conversation Groups

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

user_id
string
required

Required ID of the user whose conversation history to retrieve. The user must belong to your school.

Required string length: 1 - 255
Pattern: \S
page
integer
default:1

Page number. Follow next_page until null.

Required range: 1 <= x <= 10000
per_page
integer
default:30

Maximum number of results per page.

Required range: 1 <= x <= 30

Search title, non-deleted message content, or participant name/email.

Maximum string length: 10000
member_id
string

Filter the selected user's conversations by a participating member ID.

Required string length: 1 - 255
participant_user_id
string

Filter the selected user's conversations by another participating user ID.

Required string length: 1 - 255
email
string

Filter by a participant's email, ignoring case and surrounding spaces. No match returns no conversations. When several participant filters are supplied, any match is included.

Maximum string length: 10000
filter
enum<string>

Filter the selected user's conversations by unread, followed or archived status, or by step completion.

Available options:
unread,
followed,
pending_step_validation,
validated_steps,
archived
archived
boolean
default:false

Use true for archived conversations only or false to exclude them. Can be combined with another filter. filter=archived takes precedence.

sort
enum<string>
default:last_activity_at

Sort by latest activity by default. Matching activity dates are ordered by conversation ID.

Available options:
last_activity_at,
created_at_desc,
created_at_asc

Response

List of conversation groups.

data
object[]
required
Maximum array length: 30
page
integer
required
next_page
integer | null
required