> ## Documentation Index > Fetch the complete documentation index at: https://docs.slate-labs.com/llms.txt > Use this file to discover all available pages before exploring further. # List Customers > List customers with full filter support, returning a paginated envelope. Response shape: {items: [...], total: N, total_capped: bool, page: N, page_size: N}. KPI counters use GET /customers/kpis/summary; the list total is capped at 10,000 (total_capped=true). ## OpenAPI ````yaml /openapi.json get /customers openapi: 3.1.0 info: title: Slate API version: 1.0.0 description: Trading infrastructure API. servers: - url: https://api.{your-broker}.slate-labs.com variables: your-broker: default: broker security: [] tags: - name: Authentication - name: API Tokens - name: Customers - name: Accounts - name: Orders - name: Instruments & Groups - name: Transactions - name: Payments - name: Transfers - name: Risk - name: Workflow & CRM - name: Messaging - name: Integrations - name: Webhooks - name: Compliance - name: Promo codes - name: Reporting - name: Audit - name: Fraud & moderation - name: Broker settings - name: Users - name: Roles & Teams - name: Streams (SSE) - name: Simulator - name: Observability - name: Prop trading paths: /customers: get: tags: - Customers summary: List Customers description: >- List customers with full filter support, returning a paginated envelope. Response shape: {items: [...], total: N, total_capped: bool, page: N, page_size: N}. KPI counters use GET /customers/kpis/summary; the list total is capped at 10,000 (total_capped=true). operationId: list_customers_customers_get parameters: - name: ids in: query required: false schema: anyOf: - type: array items: type: string format: uuid - type: 'null' description: >- Batch lookup: return only customers whose id is in this set (repeat the param). Lets the CRM resolve many customer names in a single scoped call instead of one GET /customers/{id} per row. title: Ids description: >- Batch lookup: return only customers whose id is in this set (repeat the param). Lets the CRM resolve many customer names in a single scoped call instead of one GET /customers/{id} per row. - name: owner_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Owner Id - name: unassigned in: query required: false schema: anyOf: - type: boolean - type: 'null' description: If true, return only customers with no owner (owner_id IS NULL) title: Unassigned description: If true, return only customers with no owner (owner_id IS NULL) - name: country in: query required: false schema: anyOf: - items: type: string type: array - type: 'null' title: Country - name: kyc_status_id in: query required: false schema: anyOf: - type: array items: type: integer - type: 'null' title: Kyc Status Id - name: sales_status_id in: query required: false schema: anyOf: - type: array items: type: integer - type: 'null' title: Sales Status Id - name: affiliate_id in: query required: false schema: anyOf: - type: string - type: 'null' description: contains match title: Affiliate Id description: contains match - name: campaign_id in: query required: false schema: anyOf: - type: string - type: 'null' description: contains match title: Campaign Id description: contains match - name: has_ftd in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Has Ftd - name: is_active in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Is Active - name: retention_status in: query required: false schema: anyOf: - type: string - type: 'null' title: Retention Status - name: risk_classification in: query required: false schema: anyOf: - type: string - type: 'null' title: Risk Classification - name: compliance_status in: query required: false schema: anyOf: - type: string - type: 'null' title: Compliance Status - name: search in: query required: false schema: anyOf: - type: string - type: 'null' title: Search - name: registration_source in: query required: false schema: anyOf: - type: string - type: 'null' description: organic / affiliate / import / promo title: Registration Source description: organic / affiliate / import / promo - name: funnel in: query required: false schema: anyOf: - type: string - type: 'null' description: contains match title: Funnel description: contains match - name: promo_code_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Promo Code Id - name: last_activity_from in: query required: false schema: anyOf: - type: string format: date - type: 'null' title: Last Activity From - name: last_activity_to in: query required: false schema: anyOf: - type: string format: date - type: 'null' title: Last Activity To - name: last_login_from in: query required: false schema: anyOf: - type: string format: date - type: 'null' title: Last Login From - name: last_login_to in: query required: false schema: anyOf: - type: string format: date - type: 'null' title: Last Login To - name: reg_from in: query required: false schema: anyOf: - type: string format: date - type: 'null' title: Reg From - name: reg_to in: query required: false schema: anyOf: - type: string format: date - type: 'null' title: Reg To - name: ftd_from in: query required: false schema: anyOf: - type: string format: date - type: 'null' title: Ftd From - name: ftd_to in: query required: false schema: anyOf: - type: string format: date - type: 'null' title: Ftd To - name: page in: query required: false schema: type: integer minimum: 1 default: 1 title: Page - name: page_size in: query required: false schema: type: integer maximum: 500 minimum: 1 default: 50 title: Page Size - name: sort_by in: query required: false schema: anyOf: - type: string - type: 'null' title: Sort By - name: sort_dir in: query required: false schema: anyOf: - type: string - type: 'null' default: desc title: Sort Dir responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - bearerAuth: [] components: schemas: HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError 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 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````