List Users

This endpoint fetches user data based on filters like name, status, archive state, usage metrics, reporting manager, and cost center. Supports pagination and sorting.

Supported Filters Table:

FieldTypeDescription / Allowed Values
user_idstringUser ID
user_namestringUser Name
user_emailstringUser Email
user_statusenumUser Status (active, inactive, suspended, unknown)
user_account_typeenumAccount Type (group, employee, service, external)
user_department_idstringDepartment ID
user_designationstringJob Title
user_owner_idstringOwner
user_alternate_emailsstringAlternate Emails
source_arraystringSources
primary_sourcestringPrimary Source
user_joining_daterangeJoining Date (range)
user_created_atrangeCreated On (range)
user_archivebooleanArchive Status
user_usagerangeUsage (Score) (range)
optimization_inclusionenumOptimization Inclusion (Excluded for all Optimizations, Excluded for Unused, Excluded for Undeprovisioned, Included for all Optimizations)
user_reporting_manager_idstringReporting Manager ID (the id of the reporting manager)
user_cost_center_idstringCost Center ID
custom_fieldsobjectCustom Fields (see example below)

Example Custom Field Filter:

{
  "field_id": "custom_fields",
  "field_values": {
    "custom_field_id": "679b613f315ee0a11cb67bd1",
    "custom_field_values": ["India"]
  }
}

Use these as field_id values inside the filter_by array in the request body to filter results.

Language
Credentials
Header
Click Try It! to start a request and see the response here!