FIfish
Agent Sessions

List Agent Sessions

Changed on

List your team's sessions, newest first. Filter by agent, status, end reason, caller number, SIP Call-ID, end user ID, call_sid, or creation time. Paginate with cursor (recommended; follow next_cursor while has_more is true) or with page for offset pagination with a total count. The two are mutually exclusive.

get/v1/agent/sessions

Request

  • Base URL
    https://api.fish.audio
  • URL
    https://api.fish.audio/v1/agent/sessions
  • Auth
    HTTP bearer

Query parameters

agent_idstring nullable
statusstring nullable

Comma-separated status filter (pending/active/completed/failed/unknown). Default: every status.

end_reasonstring nullable

Comma-separated end reason filter (user_hangup/agent_hangup/escalated/conversation_timeout/heartbeat_timeout/agent_join_timeout/internal_error/llm_endpoint_failure/room_join_timeout/cancelled/dial_failed).

directionstring nullable

Filter by call direction (inbound/outbound). Sessions predating the field count as inbound.

caller_numberstring nullable

Exact-match caller E.164 (phone sessions only).

sip_call_idstring nullable

Exact-match SIP Call-ID of the call's INVITE, for looking up the session behind a carrier CDR entry (phone sessions only).

end_user_idstring nullable

Exact-match end_user_id set at session creation.

call_sidstring nullable

Exact-match carrier call id (Twilio's CallSid on inbound calls through a Twilio number), the call_sid the conversation_init request carries, for finding the session behind that request.

created_afterstring nullable
created_beforestring nullable
cursorstring nullable
pageinteger nullable

1-based page number (offset pagination). Returns total; mutually exclusive with cursor, which deep scans must use.

include_totalboolean

Also count the filtered set on the cursor path.

page_sizeinteger

Response

Request fulfilled, document follows

has_moreboolean required
next_cursorstring nullable
totalinteger nullable

Changes