List Users

post

https://api-ext.zluri.com/v2/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:

Field	Type	Description / Allowed Values
`user_id`	string	User ID
`user_name`	string	User Name
`user_email`	string	User Email
`user_status`	enum	User Status (`active`, `inactive`, `suspended`, `unknown`)
`user_account_type`	enum	Account Type (`group`, `employee`, `service`, `external`)
`user_department_id`	string	Department ID
`user_designation`	string	Job Title
`user_owner_id`	string	Owner
`user_alternate_emails`	string	Alternate Emails
`source_array`	object	Sources
`primary_source`	object	Primary Source
`user_joining_date`	range	Joining Date (range)
`user_created_at`	range	Created On (range)
`user_archive`	boolean	Archive Status
`user_usage`	range	Usage (Score) (range)
`optimization_inclusion`	enum	Optimization Inclusion (`Excluded for all Optimizations`, `Excluded for Unused`, `Excluded for Undeprovisioned`, `Included for all Optimizations`)
`user_reporting_manager_id`	string	Reporting Manager ID (the id of the reporting manager)
`user_cost_center_id`	string	Cost Center ID
`custom_fields`	object	Custom Fields (see example below)

Source Array Filter Format: For filtering by source information (integrations, agents, etc.), use the following format:

Manual Source Filter:

{
  "field_id": "source_array",
  "field_values": [
    {
      "key": "keyword",
      "value": ["manual"],
      "value_type": "string"
    }
  ]
}

Integration Source Filter:

{
  "field_id": "source_array",
  "negative": false,
  "field_values": [
    {
      "key": "org_integration_id",
      "value_type": "objectId",
      "value": ["681047a5b5c755b83e0ff982"]
    }
  ]
}

Available Source Keys:

keyword - Source keyword (e.g., "manual", "okta", "slack")
org_integration_id - Organization integration ID
global_agent_id - Global agent ID

Date Range Filter Format: For filtering by date/time fields, use the field_order parameter to specify comparison operators:

Date Range Filter (Between two dates):

{
  "field_id": "user_joining_date",
  "field_values": ["2025-11-12", "2025-11-13"],
  "field_order": ["gte", "lte"]
}

Single Date Comparison:

{
  "field_id": "user_created_at",
  "field_values": ["2025-11-12"],
  "field_order": ["gte"]
}

Available Field Order Operators:

gte - Greater than or equal to
lte - Less than or equal to
eq - Equal to
ne - Not equal to
lt - Less than
gt - Greater than

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.