Users
get
List all current users in the system.
Authorizations
Responses
200
Success
application/json
Responseall of[]
403
Access denied.
application/json
500
A generic exception has occurred.
application/json
get
GET /api/admin/users HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"id": 1,
"email": "[email protected]",
"new_password": "",
"name": "Demo Account",
"locale": "en_US",
"show_24_hour_time": true,
"two_factor_secret": "A1B2C3D4",
"created_at": 1609480800,
"updated_at": 1609480800,
"roles": []
}
]post
Create a new user.
Authorizations
Body
all ofOptional
Responses
200
Success
application/json
Responseall of
403
Access denied.
application/json
500
A generic exception has occurred.
application/json
post
POST /api/admin/users HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 209
{
"id": 1,
"email": "[email protected]",
"new_password": "",
"name": "Demo Account",
"locale": "en_US",
"show_24_hour_time": true,
"two_factor_secret": "A1B2C3D4",
"created_at": 1609480800,
"updated_at": 1609480800,
"roles": []
}{
"id": 1,
"email": "[email protected]",
"new_password": "",
"name": "Demo Account",
"locale": "en_US",
"show_24_hour_time": true,
"two_factor_secret": "A1B2C3D4",
"created_at": 1609480800,
"updated_at": 1609480800,
"roles": []
}get
Retrieve details for a single current user.
Authorizations
Path parameters
idinteger · int64Required
User ID
Responses
200
Success
application/json
Responseall of
403
Access denied.
application/json
404
Record not found.
application/json
500
A generic exception has occurred.
application/json
get
GET /api/admin/user/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*
{
"id": 1,
"email": "[email protected]",
"new_password": "",
"name": "Demo Account",
"locale": "en_US",
"show_24_hour_time": true,
"two_factor_secret": "A1B2C3D4",
"created_at": 1609480800,
"updated_at": 1609480800,
"roles": []
}put
Update details of a single user.
Authorizations
Path parameters
idinteger · int64Required
User ID
Body
all ofOptional
Responses
200
Success
application/json
403
Access denied.
application/json
404
Record not found.
application/json
500
A generic exception has occurred.
application/json
put
PUT /api/admin/user/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 209
{
"id": 1,
"email": "[email protected]",
"new_password": "",
"name": "Demo Account",
"locale": "en_US",
"show_24_hour_time": true,
"two_factor_secret": "A1B2C3D4",
"created_at": 1609480800,
"updated_at": 1609480800,
"roles": []
}{
"success": true,
"message": "Changes saved successfully.",
"formatted_message": "<b>Changes saved successfully.</b>"
}delete
Delete a single user.
Authorizations
Path parameters
idinteger · int64Required
User ID
Responses
200
Success
application/json
403
Access denied.
application/json
404
Record not found.
application/json
500
A generic exception has occurred.
application/json
delete
DELETE /api/admin/user/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*
{
"success": true,
"message": "Changes saved successfully.",
"formatted_message": "<b>Changes saved successfully.</b>"
}Last updated