Users - Admin

List users for the current company

Lists users belonging to the authenticated user's company.

By default only active users are returned. include_inactive=true also returns excluded (soft-deleted, ativo=0) users, but ONLY for a company admin — for anyone else (including system_admin/platform staff) the flag is coerced to False so excluded colleagues are never exposed. Uses the same auth context as /leads routes.

get/api/users

Query parameters

team_idinteger nullable

Optional team ID filter

Optional team ID filter

include_inactiveboolean

Company-admin only: also include excluded (ativo=0) users. Silently ignored for non-admins.

Company-admin only: also include excluded (ativo=0) users. Silently ignored for non-admins.

Headers

x-api-tokenstring nullable

Response

Successful Response

{"stackTrail":"paths:/api/users:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes