List of Businesses


The Business List API gives you a straightforward method to access the list of your businesses. This API provides a convenient solution for your applications that require business data for various purposes such as analysis, integration, or presentation.


Request and Headers

curl --location --request GET 'https://core.getfaceage.com/api/v1/business' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer your_secret_key'

Response

{success} Response 200

{
    "status": true,
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 8820,
                "user_id": 5,
                "name": "My First beauty business",
                "main_domain": "myfirst-beauty.com",
                "site": "https://www.myfirst-beauty.com",
                "country_id": 22,
                "city": null,
                "address": null,
                "zip": null,
                "contact_email": "myfirstmail@mail.com",
                "phone": null,
                "customer_type": "subscriber",
                "shopify_shop_id": 2267877,
                "business_size": "small",
                "token": "zxNPIQhoAWmY934DnqrT",
                "status": "active",
                "after_analyze_status": "none",
                "logo": "https://www.dfs.com/logo/12/66dee2aecbd36.png",
                "mail_from_address": "john@mymail.com",
                "mail_from_name": "John Smith",
                "mail_host": "sandbox.smtp.mailtrap.io",
                "mail_mailer": "smtp",
                "mail_port": 2525,
                "mail_username": "pimJplc******",
                "mail_password": "*************",
                "mail_encryption": "TLS",
                "deleted_date": null,
                "created_at": "2024-03-12T10:29:08.000000Z",
                "updated_at": "2024-03-12T10:29:08.000000Z",
                "country_list": {
                    "id": 22,
                    "name": "Belgium",
                    "code": "BE"
                },
                "access_list": [
                    {
                        "id": 26,
                        "business_id": 8820,
                        "site": "https://www.myfirst-beauty.com",
                        "created_at": "2024-03-12T10:29:08.000000Z",
                        "updated_at": "2024-03-12T10:29:08.000000Z"
                    }
                ],
                "total_bought_credits": null,
                "total_deducted_credits": {
                    "business_id": 8820,
                    "total": 6000
                },
                "invoice": [
                    {
                        "id": 83,
                        "business_id": 8820,
                        "credit": 6000,
                        "expiry_date": "2028-03-20 18:31:25",
                        "access": "all",
                        "created_at": "2024-06-10T04:31:25.000000Z",
                        "price": 12
                    }
                ]
            },
            {
                "id": 8890,
                "user_id": 5,
                "name": "My Second beauty business",
                "main_domain": "mysecond-beauty.com",
                "site": "https://www.mysecond-beauty.com",
                "country_id": 22,
                "city": null,
                "address": null,
                "zip": 1245-33455,
                "contact_email": "mysecondmail@mail.com",
                "phone": null,
                "customer_type": "subscriber",
                "shopify_shop_id": 90843434,
                "business_size": "medium",
                "token": "uttxrlKe0tp001dRuwH51",
                "status": "active",
                "after_analyze_status": true,
                "logo": "/images/logo.png",
                "mail_from_address": "sara@mymail.com",
                "mail_from_name": "Sara Smith",
                "mail_host": "sandbox.smtp.mailtrap.io",
                "mail_mailer": "smtp",
                "mail_port": 2525,
                "mail_username": "zjhfskj******",
                "mail_password": "*************",
                "mail_encryption": "TLS",
                "deleted_date": null,
                "created_at": "2023-12-20T01:45:21.000000Z",
                "updated_at": "2024-03-12T18:16:25.000000Z",
                "country_list": {
                      "id": 22,
                    "name": "Belgium",
                    "code": "BE"
                },
                "access_list": [
                    {
                         "id": 27,
                        "business_id": 9821,
                        "site": "https://www.mysecond-beauty.com",
                        "created_at": "2024-03-12T10:54:42.000000Z",
                        "updated_at": "2024-03-12T10:54:42.000000Z"
                    }
                ],
                "total_bought_credits": {
                    "business_id": 14,
                    "total": "1500"
                },
                "total_deducted_credits": null,
                "invoice": [
                    {
                        "id": 89,
                        "business_id": 9821,
                        "credit": 1500,
                        "expiry_date": "2028-08-21 19:24:51",
                        "access": "all",
                        "created_at": "2024-08-28T05:24:51.000000Z",
                        "price": 14
                    }
                ]
            }
        ],
        "first_page_url": "https://core.getfaceage.com/api/v1/business?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "https://core.getfaceage.com/api/v1/business?page=1",
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://core.getfaceage.com/api/v1/business?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "https://core.getfaceage.com/api/v1/business",
        "per_page": 10,
        "prev_page_url": null,
        "to": 10,
        "total": 10
    }
}


{warning} Response 401 : Unauthorized

{
    "message": "Unauthenticated."
}