--- title: "Search customers optimized" method: GET path: "/v1/CustomersOptimized" tags: ["CustomersOptimized"] --- # Search customers optimized `GET /v1/CustomersOptimized` Search for one or more customers optimized ## Query parameters - `search.customer_id` integer[] - `search.parent_customer_id` integer[] - `search.account_number` string[] - `search.agent_id` integer[] - `search.is_parent` boolean - `search.bill_profile_id` integer[] - `search.status` 'ALL' | 'PROSPECT' | 'PENDING' | 'CLOSED' | 'OPEN' - `search.created_date_start` string, date-time - `search.created_date_end` string, date-time - `search.updated_date_start` string, date-time - `search.updated_date_end` string, date-time - `search.suspended` boolean - `search.page_size` integer - `search.page` integer - `search.sort` string ## Response `200` OK - RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsCustomerOptimized - `ok` boolean - `has_more` boolean — Helper for pagination. Indicates there are more records returned. - `record_count` integer — Total number of records found by the search. - `records` RevAppModelsCustomerOptimized[] — List of records returned. - `customer_id` integer — Primary identifier for this customer. - `billing_address_id` integer — Identifier for address to which bills are sent. - `service_address_id` integer — Identifier for address to which service is delivered. - `listing_address_id` integer — Identifier for address listed in provider phone book. - `parent_customer_id` integer — Foreign identifier indicating a parent account. - `account_number` string — Customizable account identifier. - `activated_date` string, date-time — Date and time account activated. - `agent_id` integer — Foreign identifier indicating association with an agent. - `secondary_agent_id` integer — Additional foreign identifier indicating association with another agent (use agent_id first). - `close_date` string, date-time — Date and time account closed completely. - `created_by` integer — Foreign identifier indicating user who created this. - `created_date` string, date-time — Date and time this account was created. - `updated_date` string, date-time — Date and time this account was updated. - `email` string — Primary contact email (or emails separated by comma). - `is_parent` boolean — Indicates account is a parent to other accounts. - `registration_code` string — Unique security code needed for BillCenter.net registration. - `security_pin` string — Pin, code, or password used to verify account ownership. - `sold_by` integer — Foreign identifier indicating user who made the sale to end user. - `source` string — Describes the system or method by which the account was created. - `status` 'ALL' | 'PROSPECT' | 'PENDING' | 'CLOSED' | 'OPEN' — Current status of the account. NOTE: The ALL value is not currently supported. - `auto_debit_enabled` boolean — Indicates account is setup for auto debiting. - `auto_debit_day` integer — Indicates the day of the month debiting occurs. Set to 0 (Zero) or omit if debiting should occur on due date. - `auto_debit_payment_account_id` integer — Foreign identifier indicating the method and credentials used when debiting (i.e. credit card information). - `bill_profile_id` integer — Foreign identifier indicating the bill profile. - `billing_method` 'PRINT_ONLY' | 'EMAIL_ONLY' | 'BOTH' | 'NONE' — Indicates how bills are delivered, if at all. - `balance_limit` number, double — Balance threshold for this limiter. - `balance_limit_enabled` boolean — Indicates a balance limit is enforced. - `collection_template_id` integer — Foreign identifier indicating the collection steps to take if account becomes overdue. - `contract_end_date` string, date-time — Date service contract ends. - `contract_start_date` string, date-time — Date service contract starts. - `cycle_date` string, date-time — Current cycle date of the account. - `late_fees_enabled` boolean — Indicates account is applicable to late fee rules. - `payment_terms_days` integer — Overrides bill profile. Offsets the due date by a number of days relative to the cycle date. Can be positive or negative. When Zero, due date will be equal to the cycle date. - `tax_exempt_enabled` boolean — Indicates account has some level of tax exemption. - `tax_exempt_types` string — Expresses exactly what types of tax the account is exempt from. Multiple SureTax exemptions are separated via the '|' character. - `usage_file_enabled` boolean — Indicates account should produce a usage record export file at bill creation. - `usage_file_format` 'H2O' | 'EMI' | 'Reseller' — Indicates the format of that export file. - `payment_fees_enabled` boolean — Indicates account is applicable to payment fee rules. - `class` 'Business' | 'Residential' — Indicates account is Residential or Business. - `date_of_birth` string, date-time - `language` string — Indicates language end user speaks. - `tax_id` string — Tax identification number (SSN or EIN). - `suspended` boolean — Indicates whether this account is suspended or not. - `suspended_date` string, date-time — Date and time at least one service on the account went was marked as suspended. - `culture` string — Culture used by customer. - `prevent_closing_for_no_active_service_products` boolean — Indicates whether this account's status will change to Closed when there are no active service products. - `fields` RevAppModelsFieldValue[] - `field_id` integer — Primary identifier for this custom field. - `label` string — User-defined identifier representing the custom field. - `value` string — Value of the custom field. - `links` RevAppComponentsLink[] - `rel` string - `href` string - `links` RevAppComponentsLink[] - `rel` string - `href` string ## Other responses - `500` — InternalServerError --- [API](https://skmtc.net/rev-io/apis/rev-io-api.md) · [All operations](https://skmtc.net/rev-io/apis/rev-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rev-io/rev-io-api/revisions/135571434f6c/schema)