Search for Customer

This HTTP GET request is used to search for customers with a specific query. The request includes a query parameter "searchQuery" with the value "esther". Upon successful execution, the response returns a status code of 200 and the content type is "application/json". The response body contains a "success" flag, a "message" field, and a "data" array. The "data" array includes information about the customers, such as their IDs, user IDs, business IDs, names, phone numbers, addresses, creation dates, and other related details. Additionally, it provides details about the associated user and business for each customer.

Example Response:

{
  "success": true,
  "message": "",
  "data": [
    {
      "id": "",
      "user_id": "",
      "business_id": "",
      "app_id": "",
      "name": "",
      "phone": "",
      "thumbnail": null,
      "address": "",
      "app_created_at": "",
      "raw": "",
      "deleted_at": null,
      "created_at": "",
      "updated_at": "",
      "app_updated_at": "",
      "email": null,
      "instagram": null,
      "facebook": "",
      "tiktok": null,
      "created_by": "",
      "user": {
        "id": "",
        "user_id": "",
        "business_id": "",
        "first_name": "",
        "last_name": "",
        "phone": "",
        "email": "",
        "gender": "",
        "avatar": null,
        "dial_code": "",
        "role": "",
        "timezone": "",
        "is_subscribed": true,
        "email_verified": true,
        "created_at": "",
        "updated_at": "",
        "fullName": ""
      },
      "business": {
        "id": "",
        "business_id": "",
        "user_id": "",
        "business_type_id": "",
        "name": "",
        "code": null,
        "country": "",
        "state": "",
        "address": null,
        "currency": "",
        "logo": "",
        "is_verified": true,
        "is_active": true,
        "created_at": "",
        "updated_at": ""
      }
    }
  ]
}

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

{ "success": true, "message": "Customers found successfully!", "data": { "meta": { "total": 1, "per_page": 50, "current_page": 1, "last_page": 1, "first_page": 1, "first_page_url": "/?page=1", "last_page_url": "/?page=1", "next_page_url": null, "previous_page_url": null }, "data": [ { "id": "3268", "name": "Esther Olasunkanmi", "phone": "08121005874,08121005874", "address": "Ikorodu ", "thumbnail": null, "email": null, "instagram": null, "facebook": "@Olasunkanmi Esther", "app_created_at": "2024-04-02T22:13:54.000Z", "no_of_sales": "14", "total_amount_spent": "1793607.500000000000", "formatted_amount_spent": "$ 1,793,607.50" } ] } }

Search for Customer

Request

Responses