Get User Profile
Fetch the profile of the currently authenticated user. Returns identity details such as name, contact info, status, and associated store IDs.
When to Use
▾
Use this endpoint when you:
- Display the logged-in user's profile in your UI
- Need the user's contact details for support or notifications
- Want to verify the authenticated user's active status or store assignments
How to Use
▾
/v3/userStep 1: Authenticate
▾
Obtain a valid accessToken via the Client Credentials or Authorization Code flow.
Step 2: Send the GET Request
▾
No request body or query parameters required. Signed headers (signature, nonce, timestamp) are sufficient.
Step 3: Read the Response
▾
The item object contains the user's profile fields. A "SUCCESS" code confirms the call worked.
Request Parameters
▾
No request body. Authenticated headers only.
Response Parameters
▾
Authenticated user profile.
Unique user ID.
Example: "8190656045166232716"
User's first name.
Example: "MOHAMED"
User's last name.
Example: "YUSSUF"
Country code for contact number.
Example: "60"
User's phone number.
Example: "377334080"
User's email address.
Example: "[email protected]"
Public URL of the user's avatar image.
Example: "https://storage.googleapis.com/rm-prod-asset/img/avatar.png"
Account status (`"ACTIVE"`, `"INACTIVE"`).
Example: "ACTIVE"
List of store IDs the user belongs to.
Example: ["6170506694335521334"]
Whether the user account is active.
Example: true
Account creation timestamp.
Example: "2018-02-12T08:53:13Z"
Last update timestamp.
Example: "2018-02-12T08:53:13Z"
`"SUCCESS"` if the call succeeded. Otherwise returns an error code. See [Error Codes](../error-codes).
Example: "SUCCESS"