Skip to main content
GET
Search AdminAgentMessages
An individual message within an admin agent session conversation. Messages can be from the user, assistant, system, or tool calls/results. Each message tracks its role, content, and any tool interactions including tool name, arguments, and results. Token usage is tracked per message for cost monitoring.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the AdminAgentMessage-List role.

Query Parameters

Pagination & Sorting

integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g. Name, CreatedOn).
integer
Sort direction. 0 for ascending, 1 for descending.

Filters

integer
Filter by iD of the admin agent session linked to this message.
integer
Filter by role of the message sender: User, Assistant, System, ToolCall, or ToolResult.
string
Filter by the text content of the message.
string
Filter by name of the tool that was called or produced a result.
string
Filter by jSON-formatted arguments passed to the tool.
string
Filter by jSON-formatted result returned by the tool.
integer
Filter by number of LLM tokens consumed by this message.
integer
Filter by user who wrote the message (people only).
string
Filter by display value for Author.FullName..
string
Filter by display value for Author.Email..
integer
Filter by agent when the assistant was asked to answer, Chat when the message was for the people in the conversation.
string
Filter by jSON with the users and/or agent mentioned in the message.

Range Filters

integer
Filter by number of LLM tokens consumed by this message greater than or equal to this value.
integer
Filter by number of LLM tokens consumed by this message less than or equal to this value.
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

AdminAgentMessage[]
The list of AdminAgentMessage records matching the query. See the Get one AdminAgentMessage endpoint for the full list of properties returned for each record.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (0 = ascending, 1 = descending).
integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response