Get Customer

This page contains API Documentation to retrieve details about a customer.

Get Customer Details

This API endpoint retrieves details of customers for a particular BotPenguin Partner Agency.

Endpoint

Method	URL
GET	https://api.v7.botpenguin.com/customer/list

Parameters

Parameter	Required	Description
page	No	The page number for pagination. Default is 1.
sort	No	Sorting criteria. Default is createdAt

Headers

Header	Value	Description
authtype	Key	Must be set to 'Key'.
Authorization	Bearer	Bearer token for authentication. You can get the same from the agency admin's account on BotPenguin Dashboard.

Example Request

curl --location 'https://api.v7.botpenguin.com/customer/list?page=1&sort=createdAt' \
--header 'authtype: Key' \
--header 'Authorization: Bearer **********'

Success API Response

{
    "success": true,
    "message": "",
    "data": [
        {
            "_id": "**********",
            "name": "Kevin v3",
            "contact": {
                "email": "[e-mail]"
            },
            "verified": true,
            "status": "ACTIVE",
            "subscriptionType": "v2",
            "createdAt": "2024-04-02T07:06:03.910Z",
            "updatedAt": "2024-04-02T13:57:16.513Z",
            "lastLogin": "2024-04-02T09:48:04.402Z"
        },
    ],
    "code": 200
}

Response Fields

Field	Description
success	Indicates if the request was successful.
message	Additional information or error messages.
data	Array of customer details.
_id	Unique identifier of the customer. This will be used to retrieve customer token
name	Name of the customer.
contact.email	Email address of the customer.
verified	Indicates whether the customer is verified.
status	Status of the customer (ACTIVE, INACTIVE, etc).
subscriptionType	Type of subscription (e.g., v2).
createdAt	Date and time when the customer was created.
updatedAt	Date and time when the customer was last updated.
lastLogin	Date and time of the customer's last login.

❓ Got any questions?

If you have any questions, you can look into our repository of FAQs, most likely, you will find your answer here, If not, write us at [e-mail]