User Filtered

GET

/v2/api/user/filter

Overview

The User Filtered endpoint enables clients to retrieve a customized list of users based on optional filtering criteria.
This is especially useful for narrowing down user records based on their associations with agents, projects, and time-based activity.

Functionality

Supports multiple optional query parameters for filtering:

agent_ids: Comma-separated agent IDs to fetch users linked to specific agents.

project_ids: Comma-separated project IDs to retrieve users associated with particular projects.

start_date: Filters users created or modified on or after this date.

end_date: Filters users created or modified on or before this date.

If no parameters are provided, the endpoint returns the complete list of users.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///v2/api/user/filter' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

[
    {
        "id": 8,
        "email": "user@example.com"
    }
]

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Successfully retrieved filtered users.

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Batch Delete Users

Create User Permission

User Filtered

Overview#

Functionality#

Request

Responses

Overview

Functionality