BotPenguin for Partners
DocsSupport
  • Partner Onboarding
    • Introduction
    • Partner Onboarding
    • Understanding your plans
  • Partner PLATFORM GUIDELINES
    • Dashboard
    • Customer Management
    • Team Management
    • Plans Management
      • Configurations
      • Plans
      • Add-on
      • Invoices
    • Integration Setup
      • Setup Google reCAPTCHA
      • Setup AWS SES Account
      • Setup ChatGPT Account
      • Setup Zoho Integrations
      • Setup Google OAuth App
      • Setup RazorPay Account
      • Setup Stripe Account
      • Setup Facebook App for WhatsApp & Facebook Bots
        • Create Facebook Login for Business Configuration
        • Meta System User Token
    • Configurations
      • Retention Policy
      • Custom Domain
      • Custom Script
      • Bot templates
      • Whatsapp Templates
    • Subscriptions
    • Feedbacks
    • Brand & Account Management
  • Customer Platform Guidelines
    • New Bot Setup
      • Website Chatbot
      • WhatsApp Chatbot
        • ⚙️WhatsApp Bot Creation with Automated onboarding
        • 🐧Migration Of Whatsapp Account from other platforms to BotPenguin.
        • 🔃Reconnect Whatsapp Bot
      • Instagram Chatbot
      • Facebook Chatbot
      • Telegram Chatbot
      • Microsoft Teams Bot
    • Chatflow Setup
      • Components In Chatflow
        • Request Information
        • Send Information
        • Trigger Actions
      • 3rd Party API in Chatflows
        • ChatGPT
        • Create your custom integration
        • Call external APIs in your chat flows
    • Train Your AI Chatbot
    • Install your Website Chatbot
      • Install Website Bot on WordPress
      • Install Website Chatbot on Custom Build Website
      • Install Website Chatbot on Squarespace
    • Bot Settings
      • Website Chatbot Settings
        • Design
        • General
        • Alerts
        • Triggers
        • User Access
        • Chat Window
        • AI settings
        • Transfer Chat to WhatsApp Functionality
      • Telegram Chatbot Settings
        • General
        • Telegram Profile
      • Instagram Chatbot Settings
      • Facebook Chatbot Settings
      • WhatApp Chatbot Settings
        • General
        • Alerts
        • WhatsApp Profile
      • AI Settings
    • Automation Settings
      • WhatsApp Template Setup
      • WhatsApp Catalog Setup
      • WhatsApp Flows (Forms) Setup
      • WhatsApp Broadcast Setup
      • WhatsApp Drip Campaigns Setup
      • Facebook Auto-Reply Features
    • 3rd Party App Integrations
      • Integrate BotPenguin with Microsoft Teams
      • Integrate BotPenguin with WooCommerce
      • Integrate BotPenguin with Capsule CRM
      • Integrate BotPenguin with Elevio CRM
      • Integrate BotPenguin with Close CRM
      • Integrate BotPenguin with CalendarHero CRM
      • Integrate BotPenguin with Extraaedge CRM
      • Integrate BotPenguin with Infobip CRM
      • Integrate BotPenguin with Google Sheets
      • Integrate BotPenguin with Google Task
      • Integrate BotPenguin with HelpShift CRM
      • Integrate BotPenguin with Zendesk CRM
      • Integrate BotPenguin with LeadSquared CRM
      • Integrate BotPenguin with Zoho Desk
      • Integrate BotPenguin with SupportBee CRM
      • Integrate BotPenguin with Wealthbox CRM
      • Integrate BotPenguin with SendInBlue
      • Integrate BotPenguin with Apptivo CRM
      • Integrate BotPenguin with Freshdesk CRM
      • Integrate BotPenguin with Help Desk CRM
      • Integrate BotPenguin with Helpcrunch CRM
      • Integrate BotPenguin with Jira CRM
      • Integrate BotPenguin with KarmaCRM
      • Integrate BotPenguin with LiveAgent CRM
      • Integrate BotPenguin with NetHunt CRM
      • Integrate BotPenguin with Plivo CRM
      • Integrate BotPenguin with Recurly CRM
      • Integrate BotPenguin with Shipway CRM
      • Integrate BotPenguin with Zoho Projects
      • Integrate BotPenguin with Zoho CRM
      • Integrate BotPenguin with TeamGate CRM
      • Integrate BotPenguin with Agile CRM
      • Integrate BotPenguin with Pipedrive
      • Integrate BotPenguin with Drip CRM
      • Integrate BotPenguin with Google Calendar
      • Integrate BotPenguin with Groove
      • Integrate BotPenguin with Helpdocs
      • Integrate BotPenguin with Bitrix24
      • Integrate BotPenguin with GetResponse
      • Integrate BotPenguin with Freshworks CRM
      • Integrate BotPenguin with Insightly CRM
      • Integrate BotPenguin with Nimble CRM
      • Integrate BotPenguin with Nutshell CRM
      • Integrate BotPenguin with OntraPort CRM
      • Integrate BotPenguin with HubSpot
      • Integrate BotPenguin with WebHoper
      • Integrate BotPenguin with EngageBay
      • Integrate BotPenguin with Frontapp
      • Integrate BotPenguin with Copper
      • Integrate BotPenguin with Salesflare
      • Integrate BotPenguin with No CRM
      • Integrate BotPenguin with Helprace
      • Integrate BotPenguin with Flowlu
      • Integrate BotPenguin with Pipeline
      • Integrate BotPenguin with Zingtree
      • Integrate BotPenguin with Salesforce CRM
      • Integrate BotPenguin with Chakra CRM
      • Integrate BotPenguin with SimplyBook
      • Integrate Botpenguin with Zoho CRM
      • Integrate Botpenguin with Zapier
      • Integrate BotPenguin with Twilio
      • Integrate BotPenguin with Make.com
    • Inbox & Chat
    • Analytics
    • Teams
      • Team
      • Business hours
      • Members
      • Role
      • Using Teams in Chatflow
    • Customer's Subscription
    • Notifications
    • Developers
    • Account Management
      • Account
      • Password
      • Delete Account
    • Frequently Asked Questions (FAQs)
      • ❓Product FAQs
        • Onboarding FAQs
        • Edit your chat flow
        • Bot Installation FAQs
        • ChatGPT FAQs
        • Inbox FAQs
        • Analytics FAQs
        • Chat Flow FAQs
        • Bot Settings FAQs
        • Profile, Team & Notifications FAQs
        • WhatsApp FAQs
        • Product Update FAQs
        • Subscription FAQs
      • 🙋‍♂️Partner's FAQs
        • Onboarding
        • Affiliate Partner
        • Implementation Partner
        • Whitelabel Partner
        • WhatsApp Whitelabel Partner
        • Add-ons FAQs
        • Subscription FAQs
        • LTD FAQs
    • Chatbot Troubleshooting
  • PLATFORM UPDATES & INFO
    • 🔥What's New
    • 🐞Raise Bugs
    • 📄New Feature Request
    • 🐧BotPenguin Roadmap
    • ✍️Platform Feedback
    • 🔹Uptime Status
  • Developer Documentation
    • Partner API Documentation
      • Setting up environment
      • Get Customer
      • Create Customer
      • Update Customer
      • Delete Customer
      • Get Customer API Token
      • Get Team Members (Custom Users)
      • Get Custom User (Team Member) Token
      • Embedding the BotPenguin Inbox in 3rd Party Apps
    • API Token & Keys
      • Get All Contacts
      • Getting Groups/Segments
      • Add WhatsApp Contact
      • Delete WhatsApp Contact
      • Website Contacts & Meta Data
  • WhatsApp Cloud API by Meta
    • Setting Up Your Facebook Business Manager
    • Meta Conversation Pricing for WhatsApp Cloud API
    • Update WhatsApp Bot Profile
    • Getting a Blue Tick(previously Green Tick) on WhatsApp
  • WhatsApp Cloud API
    • GET Templates List
    • POST WhatsApp Template Message
    • POST Send Message API
  • Other
    • Terms & Conditions of Service
    • Privacy Policy
    • Service Level Agreement
    • Incident Management and Response Process
Powered by GitBook
On this page
  • Get Customer Details
  • Got any questions?

Was this helpful?

  1. Developer Documentation
  2. Partner API Documentation

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": "kevin+4@monday101.com"
            },
            "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.

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 contact@botpenguin.com

PreviousSetting up environmentNextCreate Customer

Last updated 7 months ago

Was this helpful?

Got any questions?

❓