Skip to main content
POST
Get Conversation Logs

Overview

Retrieve a paginated list of conversation records across your organization. Supports filtering by date range, agent, environment, and call status. Use this endpoint to review conversation history, monitor call completion rates, and export data for analysis.

Required Permission

conversations

Query Parameters

For some API key types, environment=development must be passed explicitly. Omitting it may return a 403 error. If you receive a permission error with no other cause, add ?environment=development to your request.

Request Body

Example cURL

Basic Pagination

Filter by Agent and Date Range

Response

Success (200)

Response Fields

Error Responses

403 Forbidden - Insufficient permissions

Use Cases

  • Reviewing conversation history for quality assurance
  • Searching for specific conversations by keyword or caller name
  • Exporting conversation data for business intelligence pipelines
  • Monitoring call completion rates over time
Use filter.startDate and filter.endDate together to narrow results to a specific reporting period. For large date ranges, combine with pageSize: 100 and iterate through all pages.
Timestamps in the response are Unix timestamps (seconds since epoch). Convert them to your local timezone for display purposes.
Save the requestId from every response. You will need it if you contact Inya support to trace a specific request.

Authorizations

x-api-key
string
header
required

API key with 'conversations' permission

Query Parameters

botId
string

Filter logs to a specific agent.

environment
enum<string>

Filter by environment.

Available options:
development,
staging,
production

Body

application/json
pageNo
integer
required

Page number to retrieve.

Required range: x >= 1
Example:

1

pageSize
integer
required

Number of conversations per page (1–100).

Required range: 1 <= x <= 100
Example:

10

searchTerm
string

Free-text search across conversation records.

filter
object

Response

Conversations retrieved successfully

status
string
Example:

"success"

requestId
string
message
string
Example:

"Conversations retrieved successfully"

response
object