Fetch communication logs for a task
Return Task communication logs newest first. Full transcripts are omitted from this list; use conversationRef.href to fetch conversation details and the transcript when available.
OpenAPI
````yaml get /api/v2/tasks/{taskId}/logs
openapi: 3.0.0
info:
version: 2.0.0
title: GetVoiceBot API
description: GetVoiceBot API Documentation
servers:
- url: https://api.getvoicebot.com
description: GetVoiceBot Production
variables:
baseUrl:
default: api.getvoicebot.com
description: Production API Root
security: []
tags:
- name: Agents
- name: Inbound Email
description: Control which senders may create inbound email work for an Agent.
- name: Features
description: Inspect capabilities available within an account hierarchy.
- name: Conversation Logs
description: Query conversation activity and calculate account-level metrics.
- name: Computer Agents
description: Set up, configure, inspect, and manage GetVoiceBot Computer Agents.
- name: Computer Agent Sessions
description: View and reset Computer Agent sessions.
- name: Accounts
- name: Agent Templates
description: Create, manage, and apply reusable Agent configurations.
paths:
/api/v2/tasks/{taskId}/logs:
get:
tags:
- Tasks
summary: Fetch communication logs for a task
description: >-
Return Task communication logs newest first. Full transcripts are
omitted from this list; use conversationRef.href to fetch conversation
details and the transcript when available.
parameters:
- name: taskId
in: path
required: true
schema:
type: string
description: Task ID
- name: targetAccountId
description: Require the Task to belong to this agent account in the organization
in: query
schema:
type: integer
- name: attemptId
in: query
description: Optional exact task attempt ID.
schema:
type: string
- name: page
in: query
description: One-based page number.
schema:
type: integer
- name: pageSize
in: query
description: Page size, capped at 100.
schema:
type: integer
- name: start
in: query
description: Optional Unix timestamp; defaults to task creation.
schema:
type: integer
- name: end
in: query
description: Optional Unix timestamp; defaults to now.
schema:
type: integer
responses:
'200':
description: Task activity logs without embedded transcripts
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
taskId:
type: string
example: task1
logs:
type: array
items:
type: object
properties:
uuid:
type: string
example: conversation-uuid
roomId:
type: string
example: room-id
taskId:
type: string
example: task1
taskAttemptId:
type: string
example: attempt-id
hasTranscript:
type: boolean
example: true
conversationRef:
type: object
properties:
roomId:
type: string
example: room-id
uuid:
type: string
example: conversation-uuid
href:
type: string
example: /api/v2/conversation/room-id/conversation-uuid
pagination:
type: object
properties:
page:
type: number
example: 1
pageSize:
type: number
example: 20
totalCount:
type: number
example: 1
xml:
name: main
application/xml:
schema:
type: object
properties:
success:
type: boolean
example: true
taskId:
type: string
example: task1
logs:
type: array
items:
type: object
properties:
uuid:
type: string
example: conversation-uuid
roomId:
type: string
example: room-id
taskId:
type: string
example: task1
taskAttemptId:
type: string
example: attempt-id
hasTranscript:
type: boolean
example: true
conversationRef:
type: object
properties:
roomId:
type: string
example: room-id
uuid:
type: string
example: conversation-uuid
href:
type: string
example: /api/v2/conversation/room-id/conversation-uuid
pagination:
type: object
properties:
page:
type: number
example: 1
pageSize:
type: number
example: 20
totalCount:
type: number
example: 1
xml:
name: main
'401':
description: Unauthorized
'403':
description: Target account is outside the organization
'404':
description: Task not found
'500':
description: Internal Server Error
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
