sessions

Read Sessions

Retrieve sessions for current user's account.

By default, only USER sessions are returned. Use include_internal=true to see all sessions.

Supports filtering by:

  • session_type: Filter by specific session type (USER, INTERNAL, DEBUG)
  • include_internal: Include all session types (overrides session_type filter)
  • team_id: Filter by team ID
  • agent_id: Filter by agent ID
  • team_identifier: Filter by team identifier string (e.g., "sales-team")
  • agent_identifier: Filter by agent identifier string (e.g., "support-agent")
  • search: Search keyword in session message content
  • from_date: Sessions created on or after this date (ISO format: 2024-01-01T00:00:00Z)
  • to_date: Sessions created on or before this date (ISO format)

Supports sorting by any session field and pagination.

get/api/v1/sessions

Request

  • Base URL: https://api.gnosari.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.gnosari.com/api/v1/sessions
  • Auth: one of:
    • HTTP bearer
    • API key in header X-AUTH-TOKEN

Query parameters

sort_bystring

Field to sort by

sort_orderstring

Sort order: ascending or descending

team_idinteger nullable

Filter by team ID

agent_idinteger nullable

Filter by agent ID

team_identifierstring nullable

Filter by team identifier string

agent_identifierstring nullable

Filter by agent identifier string

searchstring nullable

Search keyword in session messages

from_datestring nullable

Filter sessions created on or after this date (ISO format)

to_datestring nullable

Filter sessions created on or before this date (ISO format)

session_type'USER' | 'INTERNAL' | 'DEBUG'

Session type for visibility control.

Following SOLID principles:

  • Single Responsibility: Each type has one clear visibility pattern
  • Open/Closed: New types can be added without modifying existing code

Filter by specific session type (USER, INTERNAL, DEBUG)

include_internalboolean

Include INTERNAL and DEBUG sessions (admin/debug mode)

skipinteger

Number of items to skip

limitinteger

Maximum items to return

Response

Successful Response

Changes

No recorded changes to this operation across all 1 revision of this API.