Skip to main content

Get User Preferences

GET 

/v1/users/{userId}/preferences

Retrieves the current preference settings for a user account.

Preferences control how the AI Voice Platform handles calls for this user, including:

  • Call screening behavior and security level
  • Assistant voice and greeting customization
  • Notification settings
  • Scam blocking configuration

Path Parameters


    userId stringrequired

    UUID for the given user

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.


    x-hiya-account-user-id stringrequired

    The identifier of a logged-in user. Same identifier that is used for /users/{user_id}

Responses

OK

Response Body

application/json