This page contains API Documentation to retrieve details about a customer.
Get Customer Details #
This API endpoint retrieves details of customers for a particular Flowmatix Partner Agency.
Endpoint #
Method URL
GET https://api.v7.flowmatix.ai/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 Flowmatix Dashboard.
Sample Request #
Copy
Sample Response #
Copy
Response Attributes #
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 support@flowmatix.ai .