> ## 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 customers > Returns the people who have talked to your agents in this project. Customers we hold nothing about beyond their identifier are left out unless includeNoData is true. ## OpenAPI ````yaml /api-reference/openapi.documented.json get /v1/customer 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: Customer - name: Agent Endpoint - name: Tool - name: Phone Number - name: Call - name: Chat - name: Metric - name: Metric Policy - name: Metric Collection Job - name: Customer Flow - name: Customer Flow Edge Case - name: Simulation - name: Simulation Persona - name: Simulation Environment - name: Simulation Scenario - name: Simulation Run Plan - name: Simulation Template - name: Simulation Audio Clip - name: Simulation Run Plan Job - name: Simulation Job - name: HTTP Request Definition - name: Webhook - name: Issue - name: Autoimprove - name: Agent Config - name: Knowledge Base - name: Calendar Connection - name: Config - name: Organization Project - name: Organization Project Member - name: Organization Project API Key - name: Organization Config - name: CLI Auth - name: Me - name: Project - name: Usage - name: Analytics - name: Dashboard - name: Live Report - name: Benchmark - name: Health - name: Prospect Simulation - name: Campaign Credit paths: /v1/customer: get: tags: - Customer summary: List customers description: >- Returns the people who have talked to your agents in this project. Customers we hold nothing about beyond their identifier are left out unless includeNoData is true. operationId: getV1Customer parameters: - in: query name: limit schema: type: integer minimum: 1 maximum: 50 default: 20 - in: query name: page schema: type: integer minimum: 1 default: 1 - in: query name: search schema: type: string maxLength: 200 - in: query name: agentId schema: type: string format: uuid - in: query name: modality schema: type: string enum: - call - chat - in: query name: includeNoData schema: type: string enum: - 'true' - 'false' description: >- Include customers we hold nothing about beyond their identifier. Defaults to false. - in: query name: sortBy schema: type: string description: >- lastSeenAt (the default), firstSeenAt, conversationCount, voiceCount, chatCount, talkTimeMs or displayName, or field. (for example field.COMPANY) to sort by a field's value. Field keys come from GET /v1/customer/fields. Customers without a value sort last. - in: query name: sortDirection schema: type: string enum: - asc - desc default: desc - in: query name: fieldKey schema: type: string minLength: 1 maxLength: 100 description: >- Filter by this field, a key from GET /v1/customer/fields. Use with fieldOperator and, unless checking presence, fieldValue. - in: query name: fieldOperator schema: type: string enum: - EQUALS - NOT_EQUALS - CONTAINS - STARTS_WITH - IS_SET - IS_NOT_SET default: EQUALS description: >- How fieldValue is compared, ignoring case. NOT_EQUALS includes customers without the field. - in: query name: fieldValue schema: type: string minLength: 1 maxLength: 500 responses: '200': description: Customers content: application/json: schema: type: object properties: data: type: object properties: items: type: array items: type: object properties: id: type: string format: uuid description: Unique identifier of the customer displayName: type: - string - 'null' description: Null until a name is known, which is common phoneNumberE164: type: - string - 'null' externalId: type: - string - 'null' summary: type: - string - 'null' notes: type: - string - 'null' description: >- Your team's shared notes. Never sent to the agent. notesUpdatedAt: type: - string - 'null' format: date-time conversationCount: type: integer voiceCount: type: integer chatCount: type: integer talkTimeMs: type: integer description: Voice only. Chat time is not included. firstSeenAt: type: - string - 'null' format: date-time lastSeenAt: type: - string - 'null' format: date-time agentIds: type: array items: type: string format: uuid attributes: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 100 value: type: string source: type: string enum: - LIVE_EXTRACTION - POST_CALL_EXTRACTION - API - USER description: >- Where the current value came from. LIVE and POST_CALL extraction are read from conversations. isLocked: type: boolean description: >- True when newer conversations cannot change this field observedAt: type: string format: date-time evidence: type: - object - 'null' properties: value: type: string source: type: string enum: - LIVE_EXTRACTION - POST_CALL_EXTRACTION - API - USER quote: type: - string - 'null' description: >- The customer's words. Null on a project with redaction on. offsetMs: type: - integer - 'null' description: Where in the conversation this was said callId: type: - string - 'null' format: uuid chatId: type: - string - 'null' format: uuid observedAt: type: string format: date-time required: - value - source - quote - offsetMs - callId - chatId - observedAt description: >- The moment the current value was heard. Null for a value set by a person or the API. blockedValue: type: - string - 'null' description: >- What a newer conversation said while this field was locked history: type: array items: type: object properties: value: type: string source: type: string enum: - LIVE_EXTRACTION - POST_CALL_EXTRACTION - API - USER quote: type: - string - 'null' description: >- The customer's words. Null on a project with redaction on. offsetMs: type: - integer - 'null' description: Where in the conversation this was said callId: type: - string - 'null' format: uuid chatId: type: - string - 'null' format: uuid observedAt: type: string format: date-time required: - value - source - quote - offsetMs - callId - chatId - observedAt description: >- Other values this field has held or been offered, newest first required: - key - value - source - isLocked - observedAt - evidence - blockedValue - history required: - id - displayName - phoneNumberE164 - externalId - summary - notes - notesUpdatedAt - conversationCount - voiceCount - chatCount - talkTimeMs - firstSeenAt - lastSeenAt - agentIds - attributes totalCount: type: integer page: type: integer required: - items - totalCount - page required: - data '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Validation error example: type: validation code: invalid_parameter message: The request was invalid param: email description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Authentication error example: type: authentication code: unauthorized message: Authentication required description: Unauthorized '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Not found error example: type: not_found code: resource_not_found message: The requested resource could not be found description: Not Found '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 x-codeSamples: - lang: JavaScript source: |- import Roark from '@roarkanalytics/sdk'; const client = new Roark({ bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted }); const customers = await client.customer.list(); console.log(customers.data); - lang: Python source: |- import os from roark_analytics import Roark client = Roark( bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"), # This is the default and can be omitted ) customers = client.customer.list() print(customers.data) components: schemas: ErrorResponse: type: object properties: type: type: string enum: - validation - authentication - forbidden - not_found - conflict - payment_required - 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.