Get Team Members (Custom Users)

This page contains on the API Information on how you can get the team member of an customer account.

Description

This endpoint retrieves custom user (Team member) data with optional pagination and search functionality for any particular customer's account.

Request URL

https://api.v7.botpenguin.com/custom-user

Request Method

GET

Request Headers

Header	Value
Authorization	Bearer [Your Access Token]
authtype	Key

Request Parameters

Parameter	Description	Type	Required
page	Page number for pagination	integer	No
ispagination	Flag to indicate pagination	boolean	No
searchText	Text to search users by name or contact info	string	No

Sample Request

curl --location 'https://api.v7.botpenguin.com/custom-user?page=1&ispagination=true&searchText=' \
--header 'Authorization: Bearer [Your Access Token]' \
--header 'authtype: Key'

Sample Response

{
    "success": true,
    "message": "",
    "data": [
        {
            "_id": "*****************",
            "whitelabel": false,
            "name": "Dummy Name",
            "contact": {
                "phone": {
                    "number": "9876543211",
                    "prefix": "91"
                },
                "_id": "************************",
                "email": "[e-mail]"
            },
            "picture": "https://cdn.botpenguin.com/assets/avatars/sample.svg",
            "liveAvailability": "ONLINE",
            "leadsVisibility": "ASSIGNED",
            "status": "ACTIVE",
            "description": "",
            "type": "CUSTOMER",
            "unreadMessages": 47,
            "_role": "************************",
            "_parent": "************************",
            "createdAt": "2024-04-26T17:10:22.134Z",
            "updatedAt": "2024-05-14T05:37:24.820Z",
            "__v": 0
        }
    ],
    "code": 200
}

Response Attributes

Attribute	Description
success	Indicates if the request was successful.
message	Additional information or error message.
data	Array of custom user (Team member) objects.
code	HTTP status code of the response.

Data Attributes

Attribute	Description
_id	Unique identifier for the custom user.
whitelabel	Flag indicating if the user belongs to a whitelabel.
name	Name of the user.
contact	Contact information of the user.
picture	URL of the user's profile picture.
liveAvailability	Availability status of the user (e.g., ONLINE).
leadsVisibility	Visibility of leads for the user (e.g., ASSIGNED).
status	Status of the user (e.g., ACTIVE).
description	Description or additional information about the user.
type	Type of user (e.g., CUSTOMER).
unreadMessages	Number of unread messages for the user.
_role	Identifier for the user's role.
_parent	Identifier for the user's agency.
createdAt	Date and time when the user was created.
updatedAt	Date and time when the user was last updated.
__v	Version number of the user object.

Note:

• Make sure to replace [Your Access Token] with your actual access token.

• Mask confidential details such as access tokens before sharing or storing this documentation.