Users API Reference

​Properties​
​GET /api/users​
​GET /api/users/:userId​
​PUT /api/users/:userId​
​DELETE /api/users/:userId​
Users
Users are resources that have access to the Visual UGC admin panel. Users can't be created via API, but instead are created by individuals following the invitation flow.
Properties
Field
Type
Value
PUT
Definition
id
integer
​
​
User Id
username
string
​
​
Username
name
string
​
​
First name
surname
string
​
​
Last name
email
string
​
​
Email
description
string
​
​
Notes on User
display_timezone
string
​tz database​
​
Timezone used when displaying date time strings
distances
string
metric
​
​
imperial
​
Distance unit system to use when handling geo location distances
​
​
acl_groups
string or array
Admin = 1
​
​
Moderator = 2
​
​
​
​
Developer = 3
​
​
​
​
​
A list of acl group ids, comma separated or JSON array when used in JSON body
​
​
​
last_login
datetime
​
​
User's last login datetime
created_at
timestamp
​
​
User's creation time
updated_at
timestamp
​
​
User's modification time
​Back to Top​
GET users
Retrieves all users available in the Stack.
Resource URL
https://api.stackla.com/api/users
Resource Details
Rate limited
Yes
Access scope
User
Request Parameters
Name
Mandatory
Request type
Description
page
No
query
​
Page number. Default value is 1
​
​
​
| | limit | No | query |
Return limit define how many Users will be return for each request. Default is 25. Maximum limit is 100.
| | order_by | No | query |
Return Users ordered by either id, name, email, surname, username, created. Sorts by id by default.
| | order_by_direction | No | query |
Return ordered list of Users in either ascending (asc) or descending (desc) direction. Default is asc.
|
​Back to Top​
GET users/:userId
Retrieves a specific user available in the Stack by its ID.
Resource URL
https://api.stackla.com/api/users/:userId
Resource Details
Rate limited
Yes
Access scope
User
Request Parameters
Name
Mandatory
Request type
Description
userId
Yes
Request type
​
ID of the User
​
​
​
|
​Back to Top​
PUT users/:userId
Updates a specific user available in the Stack by its ID.
Resource URL
https://api.stackla.com/api/users/:userId
Resource Details
Rate limited
Yes
Access scope
User
Request Parameters
Name
Mandatory
Request type
Description
userId
Yes
endpoint
​
ID of the User
​
​
​
|
​Back to Top​
DELETE users/:userId
Deletes a specific user available in the Stack by its ID.
Resource URL
https://api.stackla.com/api/users/:userId
Resource Details
Rate limited
Yes
Access scope
User
Request Parameters
Name
Mandatory
Request type
Description
userId
Yes
endpoint
​
ID of the User
​
​
​
|
​Back to Top​

Field	Type	Value	Definition
id	integer		User Id
username	string		Username
name	string		First name
surname	string		Last name
email	string		Email
description	string		Notes on User
display_timezone	string	tz database	Timezone used when displaying date time strings
distances	string	`metric`
`imperial`		Distance unit system to use when handling geo location distances
acl_groups	string or array	`Admin = 1`
`Moderator = 2`
`Developer = 3`
	A list of acl group ids, comma separated or JSON array when used in JSON body
last_login	datetime		User's last login datetime
created_at	timestamp		User's creation time
updated_at	timestamp		User's modification time

Name	Mandatory	Request type	Description
page	No	query
Page number. Default value is 1

Name	Mandatory	Request type	Description
userId	Yes	Request type
ID of the User

Name	Mandatory	Request type	Description
userId	Yes	endpoint
ID of the User

Name	Mandatory	Request type	Description
userId	Yes	endpoint
ID of the User

Tiles API Reference

Widgets API Reference

Last modified 2mo ago