This page contains on the API Information on how you can get the team member of an customer account.
This endpoint generates a permanent token for a specified user based on their email and user type.
Request URL #
Request Method #
Request Headers #
| Header |
Value |
| Authorization |
Bearer [Your Access Token] |
| authtype |
Key |
Request Parameters #
| Parameter |
Description |
Type |
Required |
Allowed Values |
| email |
Email address of the user |
string |
Yes |
|
| type |
Type of user |
string |
Yes |
AGENT, CUSTOM_USER, CUSTOMER |
Allowed values for the type parameter #
- AGENT: For team users with default agent role
- CUSTOM_USER: For team members with a custom role
- CUSTOMER: For the main customer role
Sample Request #
Sample Response #
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.
