API Documentation
OTPflow Message
Whatsapp Campaign
RCS Campaign
SMS Campaign
Email Campaign
Attributes
- Attribute Options
- Attribute Status
- GETGet List Of Attributes
- GETGet Attribute By ID
- POSTCreate Custom Attribute
- PATCHUpdate Custom Attribute
- DELDelete Custom Attribute
Collection Records
List Entries
Activity / Task
Workspace Members
Get List of Workspace Members
This endpoint returns all worksapce member details
curl --request GET \
--url https://api.zixflow.com/api/v1/workspace-members \
--header 'Authorization: Bearer <token>'
{
"status": true,
"message": "Workspace members fetched successfully!",
"data": [
{
"workspaceId": "652e5068c33fe13b6ba00fd7",
"userId": "652e5068c33fe1cd1da00fda",
"avatar": "",
"fullName": "User Name",
"email": "user@zixflow.com",
"phone": "9190909090",
"userType": "OWNER",
"userStatus": "ACTIVE",
"timezone": "Asia/Kolkata",
"deactivated": false
}
]
}
API Response Description:
Indicates the success or failure of the workspace members retrieval. In this case, true signifies a successful operation.
Provides a human-readable message accompanying the response. In this instance, it confirms the successful retrieval of the workspace members with the message “Workspace members fetched successfully!”
An array containing details of the available workspace members. For each member in the data array:
The unique identifier of the workspace to which the member belongs.
The unique identifier of the member, allowing for precise referencing.
The URL of the member’s profile picture, if available.
The full name of the member, providing a clear identification.
The email address of the member.
The phone number of the member.
The role of the member in the workspace, such as OWNER, ADMIN, or MEMBER.
The status of the member, such as INVITED, SUSPENDED, or ACTIVE.
The timezone of the member.
Indicates whether the member is deactivated or suspended (true/false).
{
"status": true,
"message": "Workspace members fetched successfully!",
"data": [
{
"workspaceId": "652e5068c33fe13b6ba00fd7",
"userId": "652e5068c33fe1cd1da00fda",
"avatar": "",
"fullName": "User Name",
"email": "user@zixflow.com",
"phone": "9190909090",
"userType": "OWNER",
"userStatus": "ACTIVE",
"timezone": "Asia/Kolkata",
"deactivated": false
}
]
}
curl --request GET \
--url https://api.zixflow.com/api/v1/workspace-members \
--header 'Authorization: Bearer <token>'
{
"status": true,
"message": "Workspace members fetched successfully!",
"data": [
{
"workspaceId": "652e5068c33fe13b6ba00fd7",
"userId": "652e5068c33fe1cd1da00fda",
"avatar": "",
"fullName": "User Name",
"email": "user@zixflow.com",
"phone": "9190909090",
"userType": "OWNER",
"userStatus": "ACTIVE",
"timezone": "Asia/Kolkata",
"deactivated": false
}
]
}