API Reference
SupportAPI Feedback

Fetch All Users

get
https://{environment}/api/v4/users

Retrieves a list of all users from the database.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

The maximum number of items to be returned in a single response. Use it in conjunction with the offset parameter to paginate results

integer

Specifies the starting position of the data set

string

Specify First Name of the User

string

Specify Last Name of the User

string

The unique Identifier of an Employee

string

The user's phone number

string

Specify the user's email address. All communications from Azuga will be delivered to this email address

string

Specify unique username for your account. The username is required for authentication during login

string

Timezone in which the user is located

integer
enum
Defaults to 3

Unique ID indicating the user type. 3 = web admin, 6 = installer

Allowed:
string
enum
Defaults to web admin

Represents the type of User. Eg- web admin, installer

Allowed:
string

The unique Azuga ID of the Role. This is automatically generated when the Role object is created and cannot be altered

string

Role associated with the user, which defines their access permissions

boolean

Indicates whether the user's email address has been verified ('true') or not ('false')

string

search is optional

string

sort is optional

Responses

Updated 11 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago