> ## Documentation Index > Fetch the complete documentation index at: https://docs.roark.ai/llms.txt > Use this file to discover all available pages before exploring further. # List chats > Returns a paginated list of chats for the authenticated project. ## OpenAPI ````yaml /api-reference/openapi.documented.json get /v1/chat openapi: 3.1.0 info: title: Roark Analytics API description: >- The Roark Analytics API gives you access to the same API that powers the award winning Roark Analytics platform. version: 1.0.0 servers: - description: Production url: https://api.roark.ai security: - Bearer: [] tags: - name: Agent - name: Agent Endpoint - name: Call - name: Chat - name: Metric - name: Metric Policy - name: Metric Collection Job - name: Simulation Persona - name: Simulation Scenario - name: Simulation Run Plan - name: Simulation Run Plan Job - name: Simulation Job - name: HTTP Request Definition - name: Webhook - name: Issue - name: Knowledge Base - name: Call Analysis - name: Health paths: /v1/chat: get: tags: - Chat summary: List chats description: Returns a paginated list of chats for the authenticated project. operationId: getV1Chat parameters: - in: query name: limit schema: type: integer minimum: 1 maximum: 100 default: 20 description: 'Maximum number of chats to return (default: 20, max: 100)' example: 20 - in: query name: after schema: type: string description: >- Cursor for pagination - use the nextCursor value from a previous response example: >- eyJzb3J0VmFsdWUiOiIyMDI1LTAxLTE1VDEwOjAwOjAwLjAwMDAwMFoiLCJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9 - in: query name: sortBy schema: type: string enum: - createdAt - startTimestamp - endTimestamp - duration - title default: createdAt description: 'Field to sort by (default: createdAt)' example: createdAt - in: query name: sortDirection schema: type: string enum: - asc - desc default: desc description: 'Sort direction (default: desc)' example: desc - in: query name: searchText schema: type: string description: >- Search text to filter chats by id, title, summary, message text, or note content example: account balance - in: query name: simulationRunPlanJobId schema: type: string format: uuid description: >- Filter by simulation run plan job ID to get all chats from a specific simulation batch example: 550e8400-e29b-41d4-a716-446655440000 responses: '200': description: List of chats content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string format: uuid description: Unique identifier for the chat example: 550e8400-e29b-41d4-a716-446655440000 projectId: type: string format: uuid description: ID of the project this chat belongs to example: 660e8400-e29b-41d4-a716-446655440001 organizationId: type: string format: uuid description: ID of the organization this chat belongs to example: 770e8400-e29b-41d4-a716-446655440002 title: type: - string - 'null' description: Auto-generated title for the chat based on content example: Account assistance request summary: type: - string - 'null' description: Auto-generated summary of the chat conversation example: >- Customer inquired about account balance and recent transactions startTimestamp: type: string description: Timestamp when the chat started example: '2024-01-15T10:00:00Z' endTimestamp: type: string description: Timestamp when the chat ended example: '2024-01-15T10:30:00Z' durationMs: type: number description: Duration of the chat in milliseconds example: 1800000 createdAt: type: - string - 'null' description: Timestamp when the chat record was created example: '2024-01-15T10:31:00Z' updatedAt: type: - string - 'null' description: Timestamp when the chat record was last updated example: '2024-01-15T10:31:00Z' simulationJobId: type: - string - 'null' format: uuid description: >- ID of the simulation job if this chat was generated by a simulation example: 880e8400-e29b-41d4-a716-446655440003 simulationRunPlanJobId: type: - string - 'null' format: uuid description: >- ID of the simulation run plan job that this chat belongs to (if applicable) example: 990e8400-e29b-41d4-a716-446655440004 agents: type: - array - 'null' items: type: object properties: id: type: string format: uuid required: - id description: Agent information example: - id: 550e8400-e29b-41d4-a716-446655440000 customers: type: - array - 'null' items: type: object properties: phoneNumberE164: type: - string - 'null' label: type: - string - 'null' description: Customer information example: - phoneNumberE164: null label: web-visitor-abc123 properties: type: - object - 'null' additionalProperties: path: /v1/integrations/livekit-sdk/chunk-upload-url description: Custom properties associated with the chat example: source: web region: US policyIds: type: - array - 'null' items: type: string format: uuid description: >- IDs of metric policies that have been applied to this chat example: - 550e8400-e29b-41d4-a716-446655440000 externalId: type: - string - 'null' description: >- Caller-supplied correlation ID echoed back from the create request, if any was provided example: session-abc-123 required: - id - projectId - organizationId - startTimestamp - endTimestamp - durationMs title: ChatResponse description: Response containing the chat information pagination: type: object properties: total: type: number description: Total number of items hasMore: type: boolean description: Whether there are more items to fetch nextCursor: type: - string - 'null' description: Cursor for the next page of items required: - total - hasMore - nextCursor required: - data - pagination '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Authentication error example: type: authentication code: unauthorized message: Authentication required description: Unauthorized '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Server error example: type: internal code: internal_error message: Internal server error description: Internal Server Error components: schemas: ErrorResponse: type: object properties: type: type: string enum: - validation - authentication - forbidden - not_found - conflict - rate_limit - internal description: The error type category examples: - validation - authentication code: type: string description: Machine-readable error code identifier examples: - invalid_parameter - missing_required_field - unauthorized message: type: string description: Human-readable error message examples: - The request was invalid - Authentication required param: type: string description: The parameter that caused the error (if applicable) examples: - email - user_id details: description: Additional error context information required: - type - code - message securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT ````