curl -X GET "<base_url>/usermanagement/v1/users" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"code": 1,
"message": "Accounts fetched successfully",
"response_code": 1
},
"body": [
{
"username": "string",
"uuid": "string",
"profileId": "string",
"status": 1,
"isExpired": 0,
"isDeleted": 0,
"subscriptionType": "paid",
"expiryDate": "17-07-2026",
"createdAt": "2026-06-16T10:24:00Z",
"updatedAt": "2026-06-16T10:24:00Z",
"services": [
{
"slug": "rmd",
"status": 1,
"isExpired": 0,
"subscriptionType": "paid",
"expiryDate": "17-07-2026",
"firstName": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"dateOfBirth": "string",
"addressLine1": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"countryId": 1,
"countrySlug": "US"
}
]
}
]
}
User Management
List Users
Retrieves a paginated list of users.
GET
/
usermanagement
/
v1
/
users
curl -X GET "<base_url>/usermanagement/v1/users" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"code": 1,
"message": "Accounts fetched successfully",
"response_code": 1
},
"body": [
{
"username": "string",
"uuid": "string",
"profileId": "string",
"status": 1,
"isExpired": 0,
"isDeleted": 0,
"subscriptionType": "paid",
"expiryDate": "17-07-2026",
"createdAt": "2026-06-16T10:24:00Z",
"updatedAt": "2026-06-16T10:24:00Z",
"services": [
{
"slug": "rmd",
"status": 1,
"isExpired": 0,
"subscriptionType": "paid",
"expiryDate": "17-07-2026",
"firstName": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"dateOfBirth": "string",
"addressLine1": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"countryId": 1,
"countrySlug": "US"
}
]
}
]
}
Retrieves a paginated list of users.
See Errors for the response envelope and the full list of codes.
- URL:
/usermanagement/v1/users - Full URL:
<base_url>/usermanagement/v1/users - Request Method: GET
Authentication
Send the Access Token in theX-AccessToken request header on every authenticated call:
X-AccessToken: YOUR_ACCESS_TOKEN
Query Parameters
number
Page number.
number
Number of records per page.
string
Field to sort the results by.
string
Sort direction (asc or desc)
string
Free-text search keyword.
Sample Request
cURL
curl -X GET "<base_url>/usermanagement/v1/users" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
curl -X GET "<base_url>/usermanagement/v1/users" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
Response
object
object[]
Show body
Show body
string
The user’s username.
string
External identifier of the user.
string
Internal profile id (used by downstream services).
number
Account status flag.
number
Whether the account is expired (
0 = no, 1 = yes).number
Whether the account is deleted (
0 = no, 1 = yes).string
Subscription type.
string
Subscription expiry date.
string
Account creation timestamp.
string
Account last-update timestamp.
object[]
Subscribed services.
Show services
Show services
string
Service slug.
number
Account status flag.
number
Whether the account is expired (
0 = no, 1 = yes).string
Subscription type.
string
Subscription expiry date.
string
User’s first name.
string
User’s last name.
string
User’s email address.
string
User’s phone number.
string
Date of birth, format
DD-MM-YYYY.string
Street address (Line 1).
string
City name.
string
U.S. state.
string
U.S. ZIP or ZIP+4 postal code.
number
Numeric country identifier.
string
ISO country code / slug (e.g.
US).Sample Response
Success
{
"header": {
"code": 1,
"message": "Accounts fetched successfully",
"response_code": 1
},
"body": [
{
"username": "string",
"uuid": "string",
"profileId": "string",
"status": 1,
"isExpired": 0,
"isDeleted": 0,
"subscriptionType": "paid",
"expiryDate": "17-07-2026",
"createdAt": "2026-06-16T10:24:00Z",
"updatedAt": "2026-06-16T10:24:00Z",
"services": [
{
"slug": "rmd",
"status": 1,
"isExpired": 0,
"subscriptionType": "paid",
"expiryDate": "17-07-2026",
"firstName": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"dateOfBirth": "string",
"addressLine1": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"countryId": 1,
"countrySlug": "US"
}
]
}
]
}
{
"header": {
"code": 1,
"message": "Accounts fetched successfully",
"response_code": 1
},
"body": [
{
"username": "string",
"uuid": "string",
"profileId": "string",
"status": 1,
"isExpired": 0,
"isDeleted": 0,
"subscriptionType": "paid",
"expiryDate": "17-07-2026",
"createdAt": "2026-06-16T10:24:00Z",
"updatedAt": "2026-06-16T10:24:00Z",
"services": [
{
"slug": "rmd",
"status": 1,
"isExpired": 0,
"subscriptionType": "paid",
"expiryDate": "17-07-2026",
"firstName": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"dateOfBirth": "string",
"addressLine1": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"countryId": 1,
"countrySlug": "US"
}
]
}
]
}
Status Codes
| Status | Meaning |
|---|---|
200 | Success. |
500 | Internal Server Error. |
Error codes
Returned inheader.response_code when the request fails.
| Code | Message |
|---|---|
998 | Internal server error |
1002 | You are not permitted to the resource! |