Skip to main content

Retrieve a user

GET 
/api/v1/domains/:domain_uuid/users/:user_uuid

Returns one FS PBX user's profile and access assignments in the specified account. Use this endpoint to inspect the user's current details before making changes, including their name, email, enabled status, time zone, assigned extension, roles, managed accounts, and locations.

groups contains role UUIDs; accounts and account_groups identify the accounts and account groups the user is assigned to manage. locations contains assigned location UUIDs, and directory_managed indicates whether the user is linked to a connected directory.

Requires domain access and user_view. The user must belong to the domain in the URL. Passwords, API tokens, and two-factor secrets are never returned.

Request​

Responses​