> ## Documentation Index > Fetch the complete documentation index at: https://docs.stella-commerce.com/llms.txt > Use this file to discover all available pages before exploring further. # List Customers > List all customers. Search by email, name, or phone. Filter by source channel. ## OpenAPI ````yaml /api-reference/openapi.json get /api/dashboard/customers openapi: 3.1.0 info: title: Agentic Commerce API description: |2- Agentic Commerce API - E-commerce Backend ## APIs ### Dashboard API (`/api/dashboard`) Authenticated endpoints for merchant management: - Products, Variants, Options - Inventory management - Orders and fulfillment - Customers - Collections ### Storefront API (`/api/storefront`) Public endpoints for client websites: - Product catalog - Collections - Cart management - Checkout ### Sync API (`/api/sync`) Integration endpoints for zunkiree-search: - Product sync - Availability checks - Order creation from AI widget version: 1.0.0 servers: [] security: [] paths: /api/dashboard/customers: get: tags: - Dashboard - Customers summary: List Customers description: |- List all customers. Search by email, name, or phone. Filter by source channel. operationId: list_customers_api_dashboard_customers_get parameters: - name: page in: query required: false schema: type: integer minimum: 1 default: 1 title: Page - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 20 title: Limit - name: search in: query required: false schema: anyOf: - type: string - type: 'null' title: Search - name: source in: query required: false schema: anyOf: - type: string - type: 'null' title: Source - name: authorization in: header required: false schema: anyOf: - type: string - type: 'null' title: Authorization - name: X-API-Key in: header required: false schema: anyOf: - type: string - type: 'null' title: X-Api-Key - name: X-Stella-Merchant-Id in: header required: false schema: anyOf: - type: string - type: 'null' title: X-Stella-Merchant-Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: CustomerListResponse: properties: customers: items: $ref: '#/components/schemas/CustomerResponse' type: array title: Customers total: type: integer title: Total page: type: integer title: Page limit: type: integer title: Limit pages: type: integer title: Pages type: object required: - customers - total - page - limit - pages title: CustomerListResponse description: Schema for paginated customer list. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError CustomerResponse: properties: id: type: string format: uuid title: Id merchant_id: type: string format: uuid title: Merchant Id email: anyOf: - type: string - type: 'null' title: Email source: type: string title: Source default: web external_id: anyOf: - type: string - type: 'null' title: External Id phone: anyOf: - type: string - type: 'null' title: Phone first_name: anyOf: - type: string - type: 'null' title: First Name last_name: anyOf: - type: string - type: 'null' title: Last Name full_name: type: string title: Full Name default_address: anyOf: - $ref: '#/components/schemas/AddressSchema' - type: 'null' addresses: items: $ref: '#/components/schemas/AddressSchema' type: array title: Addresses accepts_marketing: type: boolean title: Accepts Marketing orders_count: type: integer title: Orders Count total_spent: type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Total Spent average_order_value: type: number title: Average Order Value created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At has_password: type: boolean title: Has Password default: false email_verified_at: anyOf: - type: string format: date-time - type: 'null' title: Email Verified At marketing_opt_in: type: boolean title: Marketing Opt In default: false failed_login_count: type: integer title: Failed Login Count default: 0 locked_until_at: anyOf: - type: string format: date-time - type: 'null' title: Locked Until At saved_addresses: items: $ref: '#/components/schemas/CustomerSavedAddress' type: array title: Saved Addresses default: [] ig_username: anyOf: - type: string - type: 'null' title: Ig Username type: object required: - id - merchant_id - last_name - full_name - default_address - addresses - accepts_marketing - orders_count - total_spent - average_order_value - created_at - updated_at title: CustomerResponse description: Schema for customer in responses. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError AddressSchema: properties: first_name: anyOf: - type: string - type: 'null' title: First Name last_name: anyOf: - type: string - type: 'null' title: Last Name company: anyOf: - type: string - type: 'null' title: Company address1: anyOf: - type: string - type: 'null' title: Address1 address2: anyOf: - type: string - type: 'null' title: Address2 city: anyOf: - type: string - type: 'null' title: City state: anyOf: - type: string - type: 'null' title: State postal_code: anyOf: - type: string - type: 'null' title: Postal Code country: anyOf: - type: string - type: 'null' title: Country phone: anyOf: - type: string - type: 'null' title: Phone type: object title: AddressSchema description: >- Schema for address. Fields are optional to support simpler address formats from AI widget. CustomerSavedAddress: properties: id: type: string format: uuid title: Id first_name: anyOf: - type: string - type: 'null' title: First Name last_name: anyOf: - type: string - type: 'null' title: Last Name company: anyOf: - type: string - type: 'null' title: Company address1: type: string title: Address1 address2: anyOf: - type: string - type: 'null' title: Address2 city: type: string title: City province: anyOf: - type: string - type: 'null' title: Province postal_code: anyOf: - type: string - type: 'null' title: Postal Code country: type: string title: Country phone: anyOf: - type: string - type: 'null' title: Phone is_default: type: boolean title: Is Default created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At type: object required: - id - first_name - last_name - company - address1 - address2 - city - province - postal_code - country - phone - is_default - created_at - updated_at title: CustomerSavedAddress description: |- A row from `customer_addresses` (Phase 2 of the agentic storefront platform). Distinct from the legacy JSONB `customers.addresses` column — the new table is the only source that supports id-addressable CRUD from the customer's own /me/addresses endpoints. ````