- A valid API key — see Obtain API credentials
| Endpoint | Method | Description |
|---|---|---|
/v1/users | GET | List all users on the authenticated client account |
/v1/users/{id} | GET | Retrieve details for a specific user |
Send GET /v1/users to retrieve every user associated with the client account linked to your API key.
curl https://api.dev.paradisegateway.net/v1/users \
-H "APIKEY: YOUR-API-KEY"The response is an array of user objects.
[
{
"id": "USER-3MtwBwLkdIwHu7ix28a3tqPa",
"object": "user",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone": "+15551234567",
"time_zone": "America/New_York",
"is_mfa_active": true,
"is_active": true,
"is_locked": false,
"correlation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
{
"id": "USER-5NvxCyMmeKxIv8jz39b4urQb",
"object": "user",
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"phone": "+15559876543",
"time_zone": "America/Chicago",
"is_mfa_active": false,
"is_active": true,
"is_locked": false,
"correlation_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
}
]Send GET /v1/users/{id} to get the full details of a single user.
curl https://api.dev.paradisegateway.net/v1/users/USER-3MtwBwLkdIwHu7ix28a3tqPa \
-H "APIKEY: YOUR-API-KEY"| Field | Description |
|---|---|
id | Unique user identifier |
email | Email address (also the login username) |
is_active | Whether the user can log in |
is_locked | Whether the account is locked (too many failed logins) |
is_mfa_active | Whether multi-factor authentication is enabled |
time_zone | User's configured time zone |
| Goal | Approach |
|---|---|
| Audit active users | List all users, filter for is_active: true |
| Find locked accounts | List all users, filter for is_locked: true |
| MFA compliance check | List all users, identify those with is_mfa_active: false |
| User lookup by email | Retrieve the full list and search client-side, or use GET /v1/users/{id} if the ID is known |