Get Caller Relations

GET /v1/users/{userId}/relations

Retrieves all caller relationship rules configured for this user.

Response Data

Returns a list of phone numbers with their assigned relation types (Block, Allow, Voicemail) and creation timestamps.

Settings Display: Show the user's blocklist, allowlist, and voicemail routing rules
Sync: Synchronize relation data across multiple user devices
Backup: Export user preferences for account migration

userId stringrequired

UUID for the given user

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}