> ## Documentation Index > Fetch the complete documentation index at: https://docs.usesimple.ai/llms.txt > Use this file to discover all available pages before exploring further. # List Calls > List all calls ## OpenAPI ````yaml GET /calls openapi: 3.1.0 info: title: Public API v1 description: >- Public API v1 requiring API keys. **Timestamps:** All datetime fields in API responses are returned in UTC using ISO 8601 format (e.g., `2024-01-15T14:30:00Z`). When filtering by date parameters, provide timestamps in ISO 8601 format. version: 0.1.0 servers: - url: https://api.prod.usesimple.ai/api/v1 description: Production API Server security: [] paths: /calls: get: tags: - Calls summary: List Calls description: >- List all calls associated with the API key's account. Includes pagination support and filtering by status, transferred state, and creation date. Date filters accept ISO 8601 format (e.g., 2024-01-15T09:30:00Z). operationId: list_calls_calls_get parameters: - name: page in: query required: false schema: anyOf: - type: integer - type: 'null' default: 1 title: Page - name: page_size in: query required: false schema: anyOf: - type: integer - type: 'null' default: 20 title: Page Size - name: status in: query required: false schema: type: string title: Status description: >- Filter by call status. Multiple values can be provided separated by commas. - name: agent_id in: query required: false schema: type: string title: Agent ID description: >- Filter by agent group UUID. Multiple values can be provided separated by commas. Returns calls from all versions of the specified agent(s). - name: agent_version_id in: query required: false schema: type: string format: uuid title: Agent Version ID description: >- Filter by specific agent version UUID. Returns calls from only the specified agent version. - name: transferred in: query required: false schema: type: boolean title: Transferred description: Filter by whether the call was transferred - name: created_at_gte in: query required: false schema: type: string format: date-time title: Created At Greater Than or Equal description: Filter calls created at or after this datetime (ISO 8601 format) - name: created_at_lte in: query required: false schema: type: string format: date-time title: Created At Less Than or Equal description: Filter calls created at or before this datetime (ISO 8601 format) - name: sort_by in: query required: false schema: type: string enum: - created_at - updated_at - started_at - ended_at - duration - status default: created_at title: Sort By description: Field to sort results by - name: sort_direction in: query required: false schema: type: string enum: - asc - desc default: desc title: Sort Direction description: Sort direction responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CallListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] components: schemas: CallListResponse: properties: calls: items: $ref: '#/components/schemas/CallDetailsResponse' type: array title: Calls total_count: type: integer title: Total Count page: type: integer title: Page page_size: type: integer title: Page Size total_pages: type: integer title: Total Pages filters: type: object properties: status: anyOf: - type: string - type: 'null' title: Status agent_id: anyOf: - type: string format: uuid - type: 'null' title: Agent ID agent_version_id: anyOf: - type: string format: uuid - type: 'null' title: Agent Version ID transferred: anyOf: - type: boolean - type: 'null' title: Transferred created_at_gte: anyOf: - type: string format: date-time - type: 'null' title: Created At Greater Than or Equal created_at_lte: anyOf: - type: string format: date-time - type: 'null' title: Created At Less Than or Equal title: Filters sorting: type: object properties: sort_by: type: string title: Sort By sort_direction: type: string title: Sort Direction title: Sorting type: object required: - calls - total_count - page - page_size - total_pages title: CallListResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError CallDetailsResponse: properties: id: type: integer title: Id simple_uuid: type: string format: uuid title: Simple Uuid record: type: boolean title: Record language: $ref: '#/components/schemas/LanguageEnum' from_number: type: string title: From Number to_number: type: string title: To Number status: type: string title: Status transferred: type: boolean title: Transferred description: Indicates if the call was transferred handoff_metadata: anyOf: - $ref: '#/components/schemas/HandoffMetadata' - type: 'null' title: Handoff Metadata description: >- Metadata about the handoff when the call was transferred to an external provider (e.g. Five9). Null if the call was not transferred. direction: type: string title: Direction description: The direction of the call (inbound/outbound) tags: type: array title: Tags description: Tags associated with the call items: type: object properties: id: type: string format: uuid name: type: string description: type: string color: type: string voice_id: anyOf: - type: string format: uuid - type: 'null' title: Voice ID description: The ID of the voice used for the call background_noise: anyOf: - type: string - type: 'null' title: Background Noise description: The background noise setting for the call agent_speaks_first: anyOf: - type: boolean - type: 'null' title: Agent Speaks First description: Whether the agent speaks first in the call agent_id: anyOf: - type: string format: uuid - type: 'null' title: Agent ID description: >- The ID of the agent used for the call. Null when the call is not associated with an agent. agent_branch: anyOf: - type: string format: uuid - type: 'null' title: Agent Branch description: >- The ID of the agent version used for the call. Null when the call is not associated with an agent. agent_commit_id: anyOf: - type: string format: uuid - type: 'null' title: Agent Commit ID description: >- The ID of the specific agent version snapshot used for the call. Null when the call is not associated with an agent. agent_branch_name: anyOf: - type: string - type: 'null' title: Agent Branch Name description: >- The name of the agent version used for the call. Null when the call is not associated with an agent. started_at: anyOf: - type: string format: date-time - type: 'null' title: Started At ended_at: anyOf: - type: string format: date-time - type: 'null' title: Ended At duration: anyOf: - type: integer - type: 'null' title: Duration created_at: type: string format: date-time title: Created At description: >- For native interactions this is the record creation time. For external-channel interactions this is the underlying session's ingestion time. Note: `created_at` sorting and the `created_at_gte`/`created_at_lte` filters order external-channel interactions by their call (leg start) time, not by this ingestion timestamp, so a returned `created_at` value may fall outside the requested filter window. external_identifiers: anyOf: - type: object additionalProperties: type: string - type: 'null' title: External Identifiers description: External identifiers associated with the call params: anyOf: - type: object additionalProperties: type: string - type: 'null' title: Params description: Parameters associated with the call prompt: anyOf: - $ref: '#/components/schemas/CallPromptResponse' - type: 'null' transcripts: items: $ref: '#/components/schemas/CallTranscriptResponse' type: array title: Transcripts recording_presigned_url: anyOf: - type: string - type: 'null' title: Recording Presigned Url call_prompt: type: string title: Call Prompt answered_by: $ref: '#/components/schemas/AnsweredByEnum' analyzers: type: array title: Analyzers description: List of analyzers configured for this call items: $ref: '#/components/schemas/AnalyzerResponse' analysis_results: type: array title: Analysis Results description: Results from analyzers that have completed items: $ref: '#/components/schemas/AnalysisResultResponse' summary: anyOf: - type: object - type: 'null' title: Summary description: The summary of the call if available keyterms: type: array items: type: string title: Keyterms description: >- Key terms configured for the agent used on the call. Empty when there is no associated agent or no key terms are configured. type: object required: - id - simple_uuid - from_number - to_number - status - started_at - ended_at - duration - created_at - prompt - transcripts - call_prompt - answered_by title: CallDetailsResponse ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError LanguageEnum: type: string enum: - en - es - ar title: Language description: The language to use for the call - English (en) or Spanish (es) HandoffMetadata: type: object title: HandoffMetadata description: Metadata about a transfer to an external provider. properties: five9: anyOf: - $ref: '#/components/schemas/Five9HandoffMetadata' - type: 'null' title: Five9 description: Five9 handoff details. Present when the transfer was to Five9. CallPromptResponse: properties: prompt_text: type: string title: Prompt Text created_at: type: string format: date-time title: Created At type: object required: - prompt_text - created_at title: CallPromptResponse CallTranscriptResponse: properties: text: anyOf: - type: string - type: 'null' title: Text role: type: string title: Role timestamp: type: string format: date-time title: Timestamp function_name: anyOf: - type: string - type: 'null' title: Function Name arguments: anyOf: - type: object - type: 'null' title: Arguments type: object required: - text - role - timestamp - function_name - arguments title: CallTranscriptResponse AnsweredByEnum: type: string enum: - voicemail - human - no_answer - unknown title: Answered By description: >- Indicates how the call was answered - by a human, voicemail, or if there was no answer AnalyzerResponse: type: object properties: id: type: string format: uuid title: Id description: Unique identifier for the analyzer prompt: type: string title: Prompt description: The prompt used for analysis output_config: type: object title: Output Config description: Configuration for the expected output format properties: type: type: string enum: - string - boolean - datetime - object description: The type of output expected properties: type: object description: >- Required when type is 'object'. Defines the structure of the object additionalProperties: type: object properties: type: type: string enum: - string - boolean - datetime required: - id - prompt - output_config title: AnalyzerResponse AnalysisResultResponse: type: object properties: id: type: string format: uuid title: Id description: Unique identifier for the analysis result analyzer_id: type: string format: uuid title: Analyzer Id description: Identifier of the analyzer that produced this result prompt: type: string title: Prompt description: The prompt used for analysis output_config: type: object title: Output Config description: Configuration for the expected output format result: type: object title: Result description: The analysis result, structure depends on the output_config required: - id - analyzer_id - prompt - output_config - result title: AnalysisResultResponse Five9HandoffMetadata: type: object title: Five9HandoffMetadata description: Details of a transfer to Five9. properties: conversation_id: type: string title: Conversation ID description: The Five9 conversation ID. Use this to correlate with Five9's API. tenant_name: anyOf: - type: string - type: 'null' title: Tenant Name description: The Five9 tenant name used for the transfer. campaign_name: anyOf: - type: string - type: 'null' title: Campaign Name description: The Five9 campaign the conversation was routed to. transferred_at: anyOf: - type: string format: date-time - type: 'null' title: Transferred At description: When the transfer occurred (ISO 8601). securitySchemes: APIKeyHeader: type: apiKey in: header name: Authorization ````