Get User Account
GET/v1/users/{userId}
Retrieves account information for a user by their unique identifier.
Response Data
The account includes:
- User Profile: User ID, phone number, and account status
Use Cases
- Account Verification: Confirm user exists before making other API calls
- Session Initialization: Load user context when app launches
- Profile Display: Show user information in settings screens
A 204 No Content response indicates the user ID is valid but no account record exists (user may need to be provisioned).
Path Parameters
userId stringrequired
The ID of the user to retrieve
Header Parameters
x-hiya-product-version string
Product version. The standard "major.minor.patch" format is highly encouraged without any leading characters; "2.1.3" or "3.0.0" for example.
Responses
- 200
- 204
- 400
- 500
OK
Response Body
No Content - User account not found
Bad Request
Response Body
Internal Server Error
Response Body