Skip to main content

View User API

The View User API retrieves a list of all users associated with the authenticated admin’s organization. It returns details across all user roles, including admin, user, and demo. Access to this endpoint requires a valid Admin_Api_Key. For security reasons, the apiKey field is returned as null in the response.

Endpoint Details:

Input Parameters

Required Headers:

HeaderValue TypeRequiredDescription
Admin-Api-keystringyesAdmin-level API key of the organization
Content-TypestringyesMust be application/json

Request Body Parameters:

No request body parameters are required. An empty JSON object {} can be passed.

Sample

Request

curl --location 'https://signals.smarte.pro/signals/v1/user/view' \
--header 'Admin_Api_Key: Flexxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxp4=' \
--header 'Content-Type: application/json' \
--data '{}'

Response

{
"message": "All User details fetched successfully",
"data": [
{
"userId": "1f4968c6-e12a-400a-b60d-4f94cfcb0b68",
"organization": {
"orgId": "8b884c5f-d9a3-4620-bf09-8dd263610581",
"orgName": "smarte",
"website": "https://www.smarte.pro/",
"cleanedWebsite": "smarte.pro",
"status": "active",
"dailyRateLimit": 10000,
"qpsLimit": 5,
"createdAt": "2025-04-10T18:49:51.000+00:00",
"updatedAt": "2025-04-10T18:52:46.000+00:00",
"adminApiKey": null
},
"email": "demo@smarte.pro",
"role": "demo",
"status": "active",
"createdAt": "2025-04-10T18:55:09.000+00:00",
"updatedAt": "2025-04-10T18:55:09.000+00:00",
"apiKey": null
},
{
"userId": "320e98cc-a90e-4b89-845d-4bfa6fb7902f",
"organization": {
"orgId": "8b884c5f-d9a3-4620-bf09-8dd263610581",
"orgName": "smarte",
"website": "https://www.smarte.pro/",
"cleanedWebsite": "smarte.pro",
"status": "active",
"dailyRateLimit": 10000,
"qpsLimit": 5,
"createdAt": "2025-04-10T18:49:51.000+00:00",
"updatedAt": "2025-04-10T18:52:46.000+00:00",
"adminApiKey": null
},
"email": "admin@smarte.pro",
"role": "admin",
"status": "active",
"createdAt": "2025-04-10T18:49:51.000+00:00",
"updatedAt": "2025-04-10T18:49:51.000+00:00",
"apiKey": null
},
{
"userId": "6d7800ad-81b0-4b60-9a0f-821a1944346b",
"organization": {
"orgId": "8b884c5f-d9a3-4620-bf09-8dd263610581",
"orgName": "smarte",
"website": "https://www.smarte.pro/",
"cleanedWebsite": "smarte.pro",
"status": "active",
"dailyRateLimit": 10000,
"qpsLimit": 5,
"createdAt": "2025-04-10T18:49:51.000+00:00",
"updatedAt": "2025-04-10T18:52:46.000+00:00",
"adminApiKey": null
},
"email": "dev.udi@smarte.pro",
"role": "user",
"status": "active",
"createdAt": "2025-04-10T18:56:50.000+00:00",
"updatedAt": "2025-04-10T18:56:50.000+00:00",
"apiKey": null
}
]
}