> ## Documentation Index > Fetch the complete documentation index at: https://docs.erp.arukz.com/llms.txt > Use this file to discover all available pages before exploring further. # List customers > Retrieve a paginated list of customers with filtering and sorting ## OpenAPI ````yaml /api-reference/openapi.json get /admin/api/v1/accounts/customers openapi: 3.0.3 info: title: ARUKZ ERP API version: v1 description: >- The REST API of ARUKZ ERP: sales, purchases, inventory, products, partners, accounts, projects and reference data. Every call acts as the user whose token it carries and sees only that user's company. servers: - url: https://erp.arukz.com description: ARUKZ ERP (hosted) security: - bearerAuth: [] tags: - name: Authentication description: Sign in for a token and sign out. - name: Sales description: Quotations, sales orders and their lines, deliveries and invoices. - name: Purchases description: Purchase orders, receipts, bills, agreements and vendor price lists. - name: Inventory description: >- Warehouses, locations, lots, stock quantities, receipts, deliveries, transfers and scrap. - name: Products description: 'The product catalogue: categories, attributes, variants and packaging.' - name: Partners description: Customers, vendors, contacts, addresses and bank accounts. - name: Accounts description: >- Invoices, bills, credit notes, refunds, taxes, journals and the chart of accounts. - name: Projects description: Projects, tasks, stages and milestones. - name: Reference data description: Currencies and rates, banks, countries, states and units of measure. paths: /admin/api/v1/accounts/customers: get: tags: - Accounts summary: List customers description: Retrieve a paginated list of customers with filtering and sorting operationId: accounts-customers-list-customers parameters: - name: include in: query required: false schema: type: string description: >- Comma-separated list of relationships to include. **Available options:** parent, country, state, title, company, industry, user, creator, addresses, contacts, bankAccounts, tags, propertyAccountPayable, propertyAccountReceivable, propertyAccountPosition, propertyPaymentTerm, propertySupplierPaymentTerm, propertyOutboundPaymentMethodLine, propertyInboundPaymentMethodLine example: propertyAccountReceivable,propertyPaymentTerm description: >- Comma-separated list of relationships to include. **Available options:** parent, country, state, title, company, industry, user, creator, addresses, contacts, bankAccounts, tags, propertyAccountPayable, propertyAccountReceivable, propertyAccountPosition, propertyPaymentTerm, propertySupplierPaymentTerm, propertyOutboundPaymentMethodLine, propertyInboundPaymentMethodLine - name: filter[id] in: query required: false schema: type: string description: Comma-separated list of IDs to filter by description: Comma-separated list of IDs to filter by - name: filter[name] in: query required: false schema: type: string description: Filter by customer name (partial match) description: Filter by customer name (partial match) - name: filter[email] in: query required: false schema: type: string description: Filter by email (partial match) description: Filter by email (partial match) - name: filter[phone] in: query required: false schema: type: string description: Filter by phone (partial match) description: Filter by phone (partial match) - name: filter[parent_id] in: query required: false schema: type: string description: Comma-separated list of parent IDs to filter by description: Comma-separated list of parent IDs to filter by - name: filter[company_id] in: query required: false schema: type: string description: Comma-separated list of company IDs to filter by description: Comma-separated list of company IDs to filter by - name: filter[country_id] in: query required: false schema: type: string description: Comma-separated list of country IDs to filter by description: Comma-separated list of country IDs to filter by - name: filter[trashed] in: query required: false schema: type: string description: |- Filter by trashed status. **Available options:** with, without, only description: |- Filter by trashed status. **Available options:** with, without, only - name: sort in: query required: true schema: type: string description: Sort field example: name description: Sort field - name: page in: query required: true schema: type: integer description: Page number example: 1 description: Page number responses: '200': description: Success content: application/json: example: data: - id: 1 account_type: individual sub_type: company name: TechNova Solutions Pvt. Ltd. email: technova@example.com phone: '1234567890' mobile: '1234567890' avatar: company-logos/01JRA5TEK5HTHJAYXSDBZRJF8B.png avatar_url: >- https://erp.arukz.com/storage/company-logos/01JRA5TEK5HTHJAYXSDBZRJF8B.png job_title: null website: https://www.technovasolutions.com tax_id: TNS123456 company_registry: TN-20251234 reference: null is_active: true color: '#AAAAAA' street1: 1234 Silicon Street street2: Tech Park city: New York zip: '10001' country_id: 233 state_id: 35 parent_id: null title_id: null company_id: 1 industry_id: null user_id: null creator_id: 1 created_at: '2025-04-07T12:34:34.000000Z' updated_at: '2025-04-08T07:46:16.000000Z' deleted_at: null country: id: 233 name: United States code: US phone_code: '1' state_required: true zip_required: true currency_id: 1 created_at: '2025-04-07T12:34:34.000000Z' updated_at: '2025-04-07T12:34:34.000000Z' state: id: 35 name: New York code: NY country_id: 233 created_at: '2025-04-07T12:34:34.000000Z' updated_at: '2025-04-07T12:34:34.000000Z' message_bounce: null supplier_rank: 0 customer_rank: 0 invoice_warning: null autopost_bills: null credit_limit: null ignore_abnormal_invoice_date: null ignore_abnormal_invoice_amount: null invoice_sending_method: null invoice_edi_format_store: null trust: null invoice_warn_msg: null debit_limit: null peppol_endpoint: null peppol_eas: null sale_warn: null comment: null sale_warn_msg: null property_account_payable_id: null property_account_receivable_id: null property_account_position_id: null property_payment_term_id: null property_supplier_payment_term_id: null property_outbound_payment_method_line_id: null property_inbound_payment_method_line_id: null - id: 1 account_type: individual sub_type: company name: TechNova Solutions Pvt. Ltd. email: technova@example.com phone: '1234567890' mobile: '1234567890' avatar: company-logos/01JRA5TEK5HTHJAYXSDBZRJF8B.png avatar_url: >- https://erp.arukz.com/storage/company-logos/01JRA5TEK5HTHJAYXSDBZRJF8B.png job_title: null website: https://www.technovasolutions.com tax_id: TNS123456 company_registry: TN-20251234 reference: null is_active: true color: '#AAAAAA' street1: 1234 Silicon Street street2: Tech Park city: New York zip: '10001' country_id: 233 state_id: 35 parent_id: null title_id: null company_id: 1 industry_id: null user_id: null creator_id: 1 created_at: '2025-04-07T12:34:34.000000Z' updated_at: '2025-04-08T07:46:16.000000Z' deleted_at: null country: id: 233 name: United States code: US phone_code: '1' state_required: true zip_required: true currency_id: 1 created_at: '2025-04-07T12:34:34.000000Z' updated_at: '2025-04-07T12:34:34.000000Z' state: id: 35 name: New York code: NY country_id: 233 created_at: '2025-04-07T12:34:34.000000Z' updated_at: '2025-04-07T12:34:34.000000Z' message_bounce: null supplier_rank: 0 customer_rank: 0 invoice_warning: null autopost_bills: null credit_limit: null ignore_abnormal_invoice_date: null ignore_abnormal_invoice_amount: null invoice_sending_method: null invoice_edi_format_store: null trust: null invoice_warn_msg: null debit_limit: null peppol_endpoint: null peppol_eas: null sale_warn: null comment: null sale_warn_msg: null property_account_payable_id: null property_account_receivable_id: null property_account_position_id: null property_payment_term_id: null property_supplier_payment_term_id: null property_outbound_payment_method_line_id: null property_inbound_payment_method_line_id: null links: first: /?page=1 last: /?page=1 prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: '« Previous' active: false - url: /?page=1 label: '1' active: true - url: null label: Next » active: false path: / per_page: 10 to: 2 total: 2 '401': description: Unauthenticated content: application/json: example: message: Unauthenticated. components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- An API token from [Sign in](/api-reference/authentication), sent as `Authorization: Bearer `. Tokens last 30 days. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.