Skip to content
getgeolens.com
GeoLens DocsEarly release

List Users

GET
/admin/users/
 
curl --request GET \
  --url 'https://example.com/api/admin/users/?skip=0&limit=50' \
  --header 'Authorization: Bearer <token>'

List all users with pagination and optional status/search filter (admin only).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
skip
Skip
integer
0
limit
Limit
integer
default: 50 >= 1 <= 200
status
Any of:
string
<= 50 characters
search
Any of:
string
<= 200 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
UserListResponse
object
users
required
Users

Page of users matching the query.

Array<object>
UserResponse
object
id
required
Id
string format: uuid
username
required
Username
string
email
required
Any of:
string
is_active
required
Is Active
boolean
status
required
Status

Account status: active, pending, suspended, or deactivated.

string
Allowed values: active pending suspended deactivated
last_login_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
roles
required
Roles

Assigned role names, e.g. [‘admin’, ‘editor’]

Array<string>
total
required
Total

Total number of users matching the query (across all pages).

integer
Example 
{
  "users": [
    {
      "status": "active"
    }
  ]
}

400

Section titled “400 ”

Bad request — invalid query parameters or payload

401

Section titled “401 ”

Unauthorized — missing or invalid credentials

403

Section titled “403 ”

Forbidden — caller lacks access to this resource

404

Section titled “404 ”

Not found

422

Section titled “422 ”

Validation error

500

Section titled “500 ”

Internal server error