Get Business Customers

This endpoint makes an HTTP GET request to retrieve a list of customers associated with the desktop application. The response returns a JSON object with a "success" status, an optional "message" field, and a "data" object containing customer information. Each customer object includes details such as ID, user ID, business ID, app ID, name, phone, thumbnail, address, creation and update timestamps, email, social media handles, and related business and user details.

The "meta" object within the "data" object provides pagination information like total number of customers, pages, and URLs for navigation.

Example response:

{
    "success": true,
    "message": "",
    "data": {
        "meta": {
            "total": 0,
            "per_page": 0,
            "current_page": 0,
            "last_page": 0,
            "first_page": 0,
            "first_page_url": "",
            "last_page_url": "",
            "next_page_url": null,
            "previous_page_url": null
        },
        "data": [
            {
                "id": "",
                "user_id": "",
                "business_id": "",
                "app_id": "",
                "name": "",
                "phone": null,
                "thumbnail": null,
                "address": null,
                "app_created_at": "",
                "raw": "",
                "deleted_at": null,
                "created_at": "",
                "updated_at": "",
                "app_updated_at": "",
                "email": null,
                "instagram": null,
                "facebook": null,
                "tiktok": null,
                "created_by": "",
                "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": ""
                },
                "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": ""
                }
            }
        ]
    }
}

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

{ "success": true, "message": "Customers fetched Successfully!", "data": { "meta": { "total": 3, "per_page": 10, "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": "3270", "user_id": "2279", "business_id": "2217", "app_id": "5", "name": "Customer A", "phone": null, "thumbnail": null, "address": null, "app_created_at": "2024-04-03T15:24:07.000+01:00", "raw": "{\"id\":5,\"name\":\"Customer A\",\"phone\":null,\"thumbnail\":null,\"email\":null,\"facebook\":null,\"instagram\":null,\"tiktok\":null,\"address\":null,\"amount_spent\":668352,\"synced\":0,\"created_at\":\"2024-04-03 15:24:07\",\"updated_at\":\"2024-04-20 00:33:11\",\"version_code\":22}", "deleted_at": null, "created_at": "2024-04-03T15:24:08.626+01:00", "updated_at": "2024-04-20T00:33:15.983+01:00", "app_updated_at": "2024-04-20T00:33:11.000+01:00", "email": null, "instagram": null, "facebook": null, "tiktok": null, "created_by": "2279", "no_of_sales": "4", "amount_spent": "₦668,352.00", "business": { "id": "2217", "business_id": "c0862576-42ab-4537-82d6-239b5263f7b3", "user_id": "2279", "business_type_id": "5", "name": "Black", "code": null, "country": "Nigeria (NGA)", "state": "Abuja FCT", "address": null, "currency": "NGN", "logo": "https://res.cloudinary.com/dwfnoynkp/image/upload/v1712097650/dev/logos/business-c0862576-42ab-4537-82d6-239b5263f7b3.jpg", "is_verified": false, "is_active": true, "created_at": "2024-04-01T18:37:51.297+01:00", "updated_at": "2024-04-02T23:40:51.046+01:00" }, "user": { "id": "2279", "user_id": "257f8893-6edd-4f77-af95-763bc0f1596a", "business_id": "2217", "first_name": "Itunuoluwa", "last_name": "Oluwakayode", "phone": "111", "email": "adelekemichael31@yahoo.com", "gender": "male", "avatar": null, "dial_code": "+234", "role": "USER", "timezone": "Africa/Lagos", "is_subscribed": true, "email_verified": true, "created_at": "2024-04-01T18:37:51.293+01:00", "updated_at": "2024-04-03T09:19:36.629+01:00", "fullName": "Itunuoluwa Oluwakayode" } }, { "id": "3268", "user_id": "2279", "business_id": "2217", "app_id": "2", "name": "Esther Olasunkanmi", "phone": "08121005874,08121005874", "thumbnail": null, "address": "Ikorodu ", "app_created_at": "2024-04-02T23:13:54.000+01:00", "raw": "{\"id\":2,\"name\":\"Esther Olasunkanmi\",\"phone\":\"08121005874,08121005874\",\"thumbnail\":null,\"email\":null,\"facebook\":\"@Olasunkanmi Esther\",\"instagram\":null,\"tiktok\":null,\"address\":\"Ikorodu \",\"amount_spent\":514804,\"synced\":0,\"created_at\":\"2024-04-02 23:13:54\",\"updated_at\":\"2024-04-18 10:19:14\",\"version_code\":19}", "deleted_at": null, "created_at": "2024-04-02T23:13:57.667+01:00", "updated_at": "2024-04-18T10:19:20.889+01:00", "app_updated_at": "2024-04-18T10:19:14.000+01:00", "email": null, "instagram": null, "facebook": "@Olasunkanmi Esther", "tiktok": null, "created_by": "2279", "no_of_sales": "6", "amount_spent": "₦514,804.00", "business": { "id": "2217", "business_id": "c0862576-42ab-4537-82d6-239b5263f7b3", "user_id": "2279", "business_type_id": "5", "name": "Black", "code": null, "country": "Nigeria (NGA)", "state": "Abuja FCT", "address": null, "currency": "NGN", "logo": "https://res.cloudinary.com/dwfnoynkp/image/upload/v1712097650/dev/logos/business-c0862576-42ab-4537-82d6-239b5263f7b3.jpg", "is_verified": false, "is_active": true, "created_at": "2024-04-01T18:37:51.297+01:00", "updated_at": "2024-04-02T23:40:51.046+01:00" }, "user": { "id": "2279", "user_id": "257f8893-6edd-4f77-af95-763bc0f1596a", "business_id": "2217", "first_name": "Itunuoluwa", "last_name": "Oluwakayode", "phone": "111", "email": "adelekemichael31@yahoo.com", "gender": "male", "avatar": null, "dial_code": "+234", "role": "USER", "timezone": "Africa/Lagos", "is_subscribed": true, "email_verified": true, "created_at": "2024-04-01T18:37:51.293+01:00", "updated_at": "2024-04-03T09:19:36.629+01:00", "fullName": "Itunuoluwa Oluwakayode" } }, { "id": "3265", "user_id": "2279", "business_id": "2217", "app_id": "1", "name": "Funke Band", "phone": "08103884423,08103884423", "thumbnail": null, "address": "Abuja", "app_created_at": "2024-04-01T21:11:00.000+01:00", "raw": "{\"id\":1,\"name\":\"Funke Band\",\"phone\":\"08103884423,08103884423\",\"thumbnail\":null,\"email\":null,\"facebook\":null,\"instagram\":null,\"tiktok\":null,\"address\":\"Abuja\",\"amount_spent\":254154.45,\"synced\":0,\"created_at\":\"2024-04-01 21:11:00\",\"updated_at\":\"2024-04-04 19:34:14\",\"version_code\":19}", "deleted_at": null, "created_at": "2024-04-01T21:11:04.166+01:00", "updated_at": "2024-04-21T14:42:29.456+01:00", "app_updated_at": "2024-04-04T19:34:14.000+01:00", "email": null, "instagram": null, "facebook": null, "tiktok": null, "created_by": "2279", "no_of_sales": "24", "amount_spent": "₦254,154.45", "business": { "id": "2217", "business_id": "c0862576-42ab-4537-82d6-239b5263f7b3", "user_id": "2279", "business_type_id": "5", "name": "Black", "code": null, "country": "Nigeria (NGA)", "state": "Abuja FCT", "address": null, "currency": "NGN", "logo": "https://res.cloudinary.com/dwfnoynkp/image/upload/v1712097650/dev/logos/business-c0862576-42ab-4537-82d6-239b5263f7b3.jpg", "is_verified": false, "is_active": true, "created_at": "2024-04-01T18:37:51.297+01:00", "updated_at": "2024-04-02T23:40:51.046+01:00" }, "user": { "id": "2279", "user_id": "257f8893-6edd-4f77-af95-763bc0f1596a", "business_id": "2217", "first_name": "Itunuoluwa", "last_name": "Oluwakayode", "phone": "111", "email": "adelekemichael31@yahoo.com", "gender": "male", "avatar": null, "dial_code": "+234", "role": "USER", "timezone": "Africa/Lagos", "is_subscribed": true, "email_verified": true, "created_at": "2024-04-01T18:37:51.293+01:00", "updated_at": "2024-04-03T09:19:36.629+01:00", "fullName": "Itunuoluwa Oluwakayode" } } ] } }

Get Business Customers

Request

Responses