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:

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.