Get User Details

This API retrieves user details for a specified time range. It supports filtering by userId, email, and signUpOriginUrl.

Get the details of the user.

GET {API_URL}/client/userDetail

Auth required: YES

Please pass your API key as the username and API secret as the password as Basic Auth to access the endpoint

Query Parameters

Name	DataType	Description	Type
from	string	Start date-time for filtering users (ISO 8601 format)	Optional
to	string	End date-time for filtering users (ISO 8601 format)	Optional
email	string	emailId of the user	Optional
signUpOriginUrl	string	The URL from where the user has come.	Optional
userId	string		Optional
gender	string	User's gender (Allowed values: MALE, FEMALE, OTHERS)	Optional
dateOfBirth	string	dob of the user	Optional
pageNumber	integer	It indicates the current page of results that the client is requesting from a larger dataset. Default value is 10 Records in 1 pageNumber	Optional
pageSize	integer	Total records that you want to show in a page no.	Optional
phone	string	phone no. of the user	Optional
googleId	string		Optional
appleId	string		Optional
facebookId	string		Optional

200: OK

{
    "data": [
        {
            "id": "67eca0ef9481efeabeb51368",
            "name": "Shivam Dubey",
            "email": "[email protected]",
            "shippingAddress": [],
            "billingAddress": [],
            "userAddress": {
                "name": "",
                "apartment": "",
                "area": "",
                "pincode": "",
                "landmark": "",
                "city": "",
                "state": "",
                "country": ""
            },
            "countryCode": "+91",
            "gender": "MALE",
            "dateOfBirth": "2025-04-01T00:00:00.000Z",
            "isPhoneVerified": false,
            "isEmailVerified": true,
            "hasPassword": false,
            "accessMethod": {
                "otp": false,
                "password": true
            },
            "createdAt": "2025-04-02T02:29:03.509Z",
            "updatedAt": "2025-04-29T15:28:22.514Z",
            "secondaryPhoneNumber": "9837394813",
            "googleId": "117611759572269030023",
            "appleId": "001350.26cfd198350448cb85e031480f577e67.0844",
            "signUpOriginUrl": "https://mock-client-demo-blog-v2-sandbox.netlify.app/politics"
        }
    ],
    "pageNumber": "1",
    "pageSize": "500",
    "countDocuments": 1
}