> ## Documentation Index > Fetch the complete documentation index at: https://flutterwaveinc.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Search customers > Search customers ## OpenAPI ````yaml Flutterwave_v4_Open_API.json post /customers/search openapi: 3.1.0 info: version: '1.0' title: Flutterwave APIs description: APIs for Enterprise Customers contact: name: Flutterwave email: hi@flutterwavego.com servers: - url: https://developersandbox-api.flutterwave.com description: Dev server security: - bearerAuth: [] paths: /customers/search: post: tags: - Customer summary: Search customers description: Search customers operationId: customers_search parameters: - $ref: '#/components/parameters/trace_id' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/size' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/customer_search_in' responses: '200': description: OK content: application/json: schema: type: object additionalProperties: false properties: status: $ref: '#/components/schemas/status' message: type: string meta: $ref: '#/components/schemas/list_response_meta' data: type: array maxItems: 10 items: $ref: '#/components/schemas/customer' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/400' '401': description: Unauthorised request content: application/json: schema: $ref: '#/components/schemas/401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/403' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/409' components: parameters: trace_id: description: >- A unique identifier to track this operation. It must be between 12 and 255 characters in length. in: header name: X-Trace-Id schema: type: string minLength: 12 maxLength: 255 example: acb123e4-f567-4a8b-9c0d-1e2f3a4b5c6d page: in: query name: page description: >- The page of the data to retrieve. The most recent data entry is on page 1. schema: type: integer minimum: 1 default: 1 example: 1 size: in: query name: size description: Length of data returned. Defaults to 10. schema: type: integer minimum: 10 maximum: 50 default: 10 example: 10 schemas: '400': description: Bad Request type: object properties: status: type: string nullable: false enum: - failed error: type: object properties: type: type: string example: REQUEST_NOT_VALID code: type: string example: '10400' message: type: string nullable: true example: Request is not valid validation_errors: type: array items: type: object properties: field_name: type: string example: amount message: type: string example: must not be null description: >- The request cannot be accepted and is malformed and/or missing required parameters. '401': description: Unauthorized type: object properties: status: type: string nullable: false enum: - failed message: type: string nullable: true description: Invalid API key provided example: UNAUTHORIZED error: type: object properties: type: type: string example: UNAUTHORIZED code: type: string example: '10401' message: type: string example: unauthorized '403': description: Forbidden type: object properties: status: type: string nullable: false enum: - failed message: type: string description: API key doesn't have permission to access this resource error: type: object properties: type: type: string example: FORBIDDEN code: type: string example: '10403' message: type: string example: Forbidden '409': description: Conflict type: object properties: status: type: string nullable: false enum: - failed message: type: string description: The request conflicts with another request error: type: object properties: type: type: string example: RESOURCE_CONFLICT code: type: string example: '10409' message: type: string example: Resource conflict customer_search_in: type: object required: - email properties: email: $ref: '#/components/schemas/email' status: type: string nullable: false enum: - success - failed list_response_meta: type: object properties: page_info: $ref: '#/components/schemas/page_info' customer: type: object properties: id: $ref: '#/components/schemas/customer_id' address: $ref: '#/components/schemas/address' email: $ref: '#/components/schemas/email' name: $ref: '#/components/schemas/name' phone: $ref: '#/components/schemas/phone' meta: $ref: '#/components/schemas/meta' created_datetime: type: string format: date-time email: type: string description: The Customer's email address. pattern: >- ^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}$ example: cornelius@gmail.com x-pattern-message: must be an email format page_info: type: object properties: total: type: integer description: The total number of items available across all pages format: int64 current_page: type: integer description: The current page number being viewed format: int64 total_pages: type: integer description: The total number of pages required to display all items. format: int64 customer_id: type: string description: ID of the customer. example: cus_3XarBILKQS address: type: object description: Customer address information. required: - line1 - city - state - country - postal_code properties: city: type: string description: The name of the city. example: New York pattern: ^.+$ x-pattern-message: value must not be empty country: description: ISO2 country code type: string pattern: ^[A-Z]{2}$ example: US x-pattern-message: must be a valid country ISO2 format line1: type: string description: The first line of the Customer's address. example: 123 Main Street pattern: ^.+$ x-pattern-message: value must not be empty line2: type: string description: The second line of the Customer's address. example: Apt 4B pattern: ^.+$ x-pattern-message: value must not be empty postal_code: type: string example: '10001' pattern: ^.+$ x-pattern-message: value must not be empty state: type: string description: The state or region. example: New York pattern: ^.+$ x-pattern-message: value must not be empty name: type: object description: The Customer's full name. properties: first: type: string description: The Customer's first name. example: King pattern: ^(?![ ,.'-]*$)[A-Za-z ,.'-]{2,50}$ x-pattern-message: >- must be between 2 and 50 characters long, cannot be empty, only spaces, or only symbols, and can only contain letters, spaces, commas, periods, apostrophes, or hyphens. middle: type: string description: The Customer's middle name. example: Leo pattern: ^(?![ ,.'-]*$)[A-Za-z ,.'-]{2,50}$ x-pattern-message: >- must be between 2 and 50 characters long, cannot be empty, only spaces, or only symbols, and can only contain letters, spaces, commas, periods, apostrophes, or hyphens. last: type: string description: The Customer's last name. example: LeBron pattern: ^(?![ ,.'-]*$)[A-Za-z ,.'-]{2,50}$ x-pattern-message: >- must be between 2 and 50 characters long, cannot be empty, only spaces, or only symbols, and can only contain letters, spaces, commas, periods, apostrophes, or hyphens. phone: type: object description: The customer's mobile number. required: - number - country_code example: country_code: '234' number: '08012345678' properties: country_code: description: ISO 3166 alpha-3 country code. type: string pattern: ^[0-9]{1,3}$ example: '234' x-pattern-message: must be a valid ISO 3166 alpha-3 country code number: description: Unformatted 7-10-digit phone number without the country code. type: string pattern: ^[0-9]{7,10}$ example: '8001122334' x-pattern-message: must be a digit containing between 7 and 10 characters meta: type: object additionalProperties: type: string securitySchemes: bearerAuth: type: http scheme: bearer ````