--- title: "List all customers" method: GET path: "/customers" tags: ["Customers"] --- # List all customers `GET /customers` ## Request - Base URL: `https://app-sandbox.resolvepay.com/api` - URL: `https://app-sandbox.resolvepay.com/api/customers` - Auth: one of: - HTTP bearer - HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Return a list of customers. For single-merchant partners, this returns customers belonging to your sub-merchants. For marketplace partners, this returns customers belonging to your marketplace. ## Query parameters - `limit` integer - `page` string - `filter` object - `merchant_id` object: Filter by sub-merchant ID. Only available for single-merchant partners. - `eq` string - `external_id` object: Filter by customer external ID. - `eq` string - `email` object - `eq` string - `business_name` object - `eq` string - `created_at` object - `eq` string, date-time - `gt` string, date-time - `lt` string, date-time - `gte` string, date-time - `lte` string, date-time - `amount_approved` object - `eq` number - `gt` number - `lt` number - `gte` number - `lte` number - `amount_available` object - `eq` number - `gt` number - `lt` number - `gte` number - `lte` number - `amount_authorized` object - `eq` number - `gt` number - `lt` number - `gte` number - `lte` number - `amount_balance` object - `eq` number - `gt` number - `lt` number - `gte` number - `lte` number - `amount_unapplied_payments` object - `eq` number - `gt` number - `lt` number - `gte` number - `lte` number - `advance_rate` object - `eq` number, double - `gt` number, double - `lt` number, double - `gte` number, double - `lte` number, double - `archived` object - `eq` boolean - `ne` boolean - `sort` string ## Response `200` An object with an array of results containing up to the limit. If no customers are found, the results array will be empty. - CustomerList - `count` integer - `limit` integer - `page` integer - `results` Customer[] - `id` string - `merchant_id` string: ID of the sub-merchant this customer belongs to. Only present for single-merchant partners. - `external_id` string, nullable: Optional customer identifier from your system. This value is not required to be unique and can be used with the `external_id` list filter. - `created_at` string, date-time: Date the customer was created. - `updated_at` string, date-time: Date the customer was last updated. - `source` 'QUICKBOOKS' | 'MERCHANT_USER' | 'ADMIN_USER' | 'APPLICATION' | 'CUSTOMER_USER' | 'API' - `business_address` string: Street address of the business' primary location. - `business_city` string: City of the business' primary location. - `business_state` string: State or province of the business' primary location. - `business_zip` string: US zip code of the business' primary location. - `business_country` string: Country of the business' primary location according to the **ISO 3166-1 alpha 2** standard. - `business_age_range` '0-2' | '2-5' | '5-10' | '10+': String indicating age of the business in years. - `business_ap_email` string: Email address of the business' accounts payable person or department. - `business_ap_phone` string: Phone number of the business' accounts payable person or department. - `business_ap_phone_extension` string: Phone number extension of the business' accounts payable person or department. - `business_name` string: Full legal name of the business being applied for. - `business_trade_name` string: Trade name of the business, if different than `business_name.` - `business_phone` string: Phone number of the business' primary location. - `business_type` 'sole_prop_or_partnership' | 'llc' | 'corporation' | 'nonprofit' | 'government': String indicating the business' type of legal entity. - `email` string, email: Email of the customer applying for terms. - `personal_name_first` string: First name of the person applying on behalf of the business. - `personal_name_last` string: Last name of the person applying on behalf of the business. - `personal_phone` string: Personal phone number of the customer representative applying for terms. - `amount_approved` integer: Total amount of the credit approved. - `amount_authorized` integer: Amount of the credit line reserved for authorized charges. - `amount_available` integer: Current amount of the credit line available for purchases. - `amount_balance` integer: Current balance on the customer's credit line. - `amount_unapplied_payments` integer: Current amount of a customer's unapplied payments. - `default_terms` 'net7' | 'net10' | 'net10th' | 'net15' | 'net20' | 'net30' | 'net45' | 'net60' | 'net75' | 'net90' | 'net120' | 'net180' | 'null', nullable: Set default terms that will apply to this customer's invoices. Can be overridden when requesting an advance. - `advance_rate` number, double, nullable: The advance rate that will be used to determine the amount advanced for this customer's invoices. - `credit_status` 'approved' | 'hold' | 'declined' | 'pending' | 'deactivated' | 'null', nullable: Current credit status of this customer. See #request-a-credit-check for more details. - `net_terms_status` 'enrolled' | 'pending_enrollment' | 'enrollment_expired' | 'null', nullable: Current net terms enrollment status of this customer. See #fetchCustomer for more details. - `net_terms_enrollment_url` string, nullable: The URL for a customer to complete enrollment requirements when net_terms_status is pending_enrollment. See #fetchCustomer for more details. - `net_terms_enrollment_expires_at` string, date-time, nullable: The date by which the customer must be enrolled in this net terms offer, not null when net_terms_status is pending_enrollment. - `credit_check_requested_at` string, date-time, nullable: The date a credit check was requested. - `archived` boolean: Boolean indicating if customer is archived. - `duns_number` string, nullable: Dun & Bradstreet unique nine-digit identifier for businesses that is associated with a business's Live Business Identity - `credit_decisions` object[]: Array of credit decisions made for this customer. - `id` string: Unique identifier for the credit decision. - `created_at` string, date-time: Date the credit decision was created. - `decision` 'approved' | 'declined' | 'hold' | 'line_adjustment' | 'deactivate': The credit decision outcome. - `amount` integer: The credit amount approved. - `advance_rate` number, double: The advance rate for this credit decision. - `decline_code` 'no_business_found' | 'thin_file' | 'failing_credit' | 'not_approved_need_more_info' | 'sole_prop' | 'applicant_business_association' | 'merchant_risk' | 'fraud' | 'no_us_address' | 'duplicate' | 'test_account' | 'email_verification_freemail' | 'email_verification_domain' | 'address_verification' | 'poor_cash_flow' | 'additional_info_not_provided' | 'other', nullable: Code indicating reason for decline, if applicable. - `hold_code` 'past_due' | 'failed_payment' | 'requested_by_customer' | 'requested_by_merchant' | 'dispute' | 'fraud' | 'churned' | 'payment_plan' | 'inactive' | 'other', nullable: Code indicating reason for hold, if applicable. ## Other responses - `400`: Bad request error - `401`: Unauthorized error - `429`: Rate limit error --- [API](https://skmtc.dev/resolvepay/apis/resolve-partners-api-reference.md) - [All operations](https://skmtc.dev/resolvepay/apis/resolve-partners-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/resolvepay/apis/resolve-partners-api-reference/revisions/5a1c75b8b404?raw)