The GET /api/users/{userId} endpoint allows you to retrieve the details of a specific user registered in the system. It provides comprehensive information about the user, including name, email, country, time zone, and other important attributes. This endpoint is useful for user management, allowing system administrators to review and manage the data of a particular user.
This endpoint is especially beneficial for applications that need to display detailed user information or for administrators who need to verify or update a specific user's data.
Request Details
HTTP Method: GET
URL: /api/users/{userId}
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | Yes | The unique identifier of the user. |
Authentication Required
Example Request
GET /api/users/12345 HTTP/1.1
Host: api.plaspy.com
Authorization: Bearer {your_auth_token}
Response Parameters
The response from this endpoint contains a detailed structure of the user. The following table describes the fields in the response:
| Field | Type | Required | Description |
|---|---|---|---|
| success | boolean | No | Indicates whether the request was successful. |
| error | string | No | Contains the error message if success is false. |
| apiUsage | integer | No | Current API usage by the user. |
| apiDailyUsage | integer | No | Daily API usage by the user. |
| id | string | No | Unique identifier of the user. |
| name | string | Yes | Name of the user. |
| string | Yes | Email of the user. | |
| country | string | Yes | Country of the user. |
| timeZone | string | Yes | Time zone of the user. |
| description | string | No | Additional description of the user. |
| message | string | No | Message associated with the user. |
| disabled | boolean | No | Indicates whether the user is disabled. |
| disabledMessage | string | No | Message describing why the user is disabled. |
| tags | object | No | Set of tags associated with the user. |
| privileges | array | No | List of user privileges. |
| group | string | No | Group to which the user belongs. |
| deviceId | string | No | Identifier of the user's device. |
| adminDevices | integer | No | Number of devices managed by the user. |
| from | string | No | Start date and time of the user's activity. |
| expires | string | No | Expiration date and time of the user. |
| password | string | No | User's password (encrypted). |
| creation | string | No | Date and time the user was created. |
| modification | string | No | Date and time of the user's last modification. |
| lastLogin | string | No | Date and time of the user's last login. |
Example Successful Response
{
"success": true,
"apiUsage": 150,
"apiDailyUsage": 15,
"id": "usr-12345",
"name": "John Doe",
"email": "john.doe@example.com",
"country": "USA",
"timeZone": "America/New_York",
"description": "System Administrator",
"message": null,
"disabled": false,
"disabledMessage": null,
"tags": {
"role": "admin"
},
"privileges": ["read", "write", "execute"],
"group": "Admins",
"deviceId": "dev-67890",
"adminDevices": 5,
"from": "2023-01-01T00:00:00Z",
"expires": "2024-01-01T00:00:00Z",
"password": null,
"creation": "2023-01-01T00:00:00Z",
"modification": "2023-06-01T00:00:00Z",
"lastLogin": "2024-05-01T00:00:00Z"
}
Example Error Response
{
"success": false,
"error": "User not found.",
"apiUsage": 150,
"apiDailyUsage": 15
}
Index
- Welcome to Plaspy help
- Map
- Viewing a Device's Route History
- Device Control Panel
- Detailed Device Information
- Buttons on the Map
- Details
- Trip Statistics
- Device Menu
- GeoFences
- Bulk Alert Editing
- Enable map notifications
- Mileage Calculation
- Atributes
- Devices
- Marker Icon
- Information
- Sensors
- Reassign Digital Sensors
- Commands
- Alerts
- Types
- Configuration
- Reminders
- Limits
- History
- Setting Up a New Tracker
- Solution for Identifier Already in Use by Another Account
- Device Issues
- Email alerts sending limits
- Reports
- New Report
- My Account
- Billing Information
- Password Change
- Email Notifications
- Telegram Accounts
- Update Mobile Phone Number
- Primary Email
- Alternative Email
- Activate Two-Factor Authentication (2FA)
- Access Log
- Password Recovery
- Recover Username
- Delete Your Account
- Subscription
- Sign Up
- Activation Code
- Payment Methods
- Line Renewal
- Free Version
- Settings
- Organization
- Login
- Contact
- Styles
- Maps
- Email Templates
- Push Notifications
- Telegram Notifications
- WhatsApp Notifications
- Mobile App
- Statistics
- Activity Summary
- Groups
- Users
- Share Access
- SMS
- Mobile Application
- Developers
- Enable the API
- Rest API
- Authentication
- Devices API
- GET /api/devices
- GET /api/devices/{deviceId}
- GET /api/devices/{deviceId}/lastLocation
- POST /api/devices/{deviceId}/locations
- POST /api/devices/{deviceId}/alerts
- Groups API
- GET /api/groups
- POST /api/groups
- GET /api/groups/{groupId}
- PUT /api/groups/{groupId}
- PATCH /api/groups/{groupId}
- DELETE /api/groups/{groupId}
- Users API
- GET /api/users
- POST /api/users
- GET /api/users/countries
- GET /api/users/timeZones
- GET /api/users/{userId}
- PUT /api/users/{userId}
- PATCH /api/users/{userId}
- DELETE /api/users/{userId}
- Embed login on my website
- Embed the map on my website
Questions
We answer all support request within 24 business hours approximately, If you have a question that needs an immediate resolution, please contact us by other way.
We answer you in business hours, as soon as possible. We are located in Bogotá, Colombia, time zone (GMT-5).
Last modification: 2024-06-06 17:58:45