Users

List users

Retrieve a paginated list of users with optional filtering.

Filtering Options:

  • Organization membership
  • User roles and permissions
  • Geographic location/states
  • Activity status
  • Search by name or email

Access Control:

  • Public: Basic user information only
  • Authenticated: Organization members visible with more detail
  • Admin: All users with full details

Query Parameters:

  • organization: Filter by organization ID
  • roles: Filter by user roles
  • search: Search by name or email
  • states: Filter by enabled states
  • is_active: Filter by active status
get/users

Query parameters

idstring

id

id__instring

id__in

organizationstring

organization

organization__instring

organization__in

referring_userstring

referring_user

referring_user__instring

referring_user__in

current_sign_in_at__gtstring

current_sign_in_at__gt

current_sign_in_at__ltstring

current_sign_in_at__lt

current_sign_in_at__ltestring

current_sign_in_at__lte

current_sign_in_at__gtestring

current_sign_in_at__gte

searchstring

search

lineagestring

lineage

rolesstring

roles

rolestring

role

has_teamstring

has_team

no_team_incidentstring

no_team_incident

sort'created_at' | '-created_at' | 'updated_at' | '-updated_at'

Ordering

recent_phone_usersstring

recent_phone_users

team_idsstring

team_ids

equipmentstring

equipment

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

Response

OK

countinteger required
nextstring uri nullable
previousstring uri nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.