Skip to main content
GET
/
agent
/
chat-logs
List Chat Logs
curl --request GET \
  --url https://api.getoutbox.ai/agent/chat-logs/ \
  --header 'Authorization: <api-key>' \
  --header 'X-User-Timezone: <x-user-timezone>'
{
  "results": [
    {
      "id": "<string>",
      "status": "<string>",
      "agent_name": "<string>",
      "agent_id": "<string>",
      "user_name": "<string>",
      "phone_number": "<string>",
      "created_at": "<string>",
      "last_activity": "<string>",
      "cost": "<string>",
      "platform": "<string>"
    }
  ],
  "total": 123
}

Authorizations

Authorization
string
header
required

Company API Key

Headers

X-User-Timezone
string
required

User's timezone for timestamp formatting

Query Parameters

page
integer
default:1

Page number for pagination. Page size is 10 items.

Search term to filter by contact name, phone number, or thread ID

status
string
default:all

Filter by conversation status

agent
string
default:all

Filter by agent ID

start_date
string<date-time>

ISO-8601 datetime string for date range start

end_date
string<date-time>

ISO-8601 datetime string for date range end

Response

Chat logs retrieved successfully

results
object[]
total
integer

Total count of chat logs