Users List

This API is used primarily to view the list of all registered users under each distributor. It can be particularly useful for administrative or management purposes, allowing client applications to display user data, verify user details, or conduct analyses based on user distribution.

Input

To fetch all users, you need to include the following authorization header in your request to ensure that the request is secure and authenticated:

User ID: The unique identifier of the user. For example, "32ce79860a45cd4857be9df097f46b4f8d".

Authorization Key: A secure key required to validate that the request comes from an authorized source.

Output

The response from this API includes the following customer details:

User ID: The unique identifier for the customer.

Full Name: The complete name of the customer.

Phone Number: The contact number of the customer.

Email Address: The email ID of the customer.

Input Type

Common error scenarios

The following are the common error scenarios in sending an API request:

---

It returns finsire_id, name, email and phone of each user.

The sample response looks like:

{
  "status": true,
  "users": [
    {
      "finsire_id": "34ec38dd9dfsd5353242234vsdf4r5324f",
      "name": "John Doe ",
      "email": "[email protected]",
      "phone": 9874562200
    },
    {
      "finsire_id": "23633ffd47348320483223fe48f057cb0f",
      "name": "ABC",
      "email": "[email protected]",
      "phone": 9874563210
    },
    {
      "finsire_id": "32ce79842f32nf5345435df097f46b4f8d",
      "name": "XYZ",
      "email": "[email protected]",
      "phone": 9876543210
    }
  ]
}

📘

Try out the API here