List Users

Retrieve the users of your account, newest first. Results can be filtered by group, status or a search keyword, and paginated with ulimit and max_uid.

GET

/api/public/users

Headers

Key	Value
Authorization	Bearer <Account API Key>

Query parameters

Parameter	Type	Description
ulimit (optional)	Integer	Maximum number of users to return. Default 25.
max_uid (optional)	Integer	Only return users whose user_id is lower than this value. To fetch the next page, pass the smallest user_id from the previous response.
gid (optional)	Integer	Only return users that belong to this group id.
search (optional)	String	Keyword to match against user name and email.
show_stats (optional)	Boolean	true to populate the stats object for each user.
list_type (optional)	String	Filter by status: active, inactive or moderate. Returns all users when omitted.

Example cURL

curl --location '<BUILDER_URL>/api/public/users?ulimit=10&search=jane&list_type=active' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXX'

Responses

Status Code	Description	Response
200	Success. Returns an array of user objects (empty array if no users match).	application/json
401	Unauthorized	application/json
500	Internal Server Error	application/json

Sample response

200 : Success

[
    {
        "stats": {
            "status": "",
            "available_content": 0,
            "consumed_content": 0,
            "app_timespent": 0
        },
        "user_id": 83,
        "user_name": "Jane Doe",
        "user_email": "jane@example.com",
        "user_desg": "Sales Manager",
        "user_image_url": "",
        "channel_id": 12,
        "channel_name": "acme",
        "app_name": "Acme Corp",
        "user_reg_date": "2026-03-14 10:22:41",
        "user_last_app_activity": null,
        "user_group": [
            {
                "grp_id": 5,
                "grp_name": "Sales"
            },
            {
                "grp_id": 9,
                "grp_name": "Default"
            }
        ],
        "is_admin": false
    }
]