Get all Users

GET

/api/v2/users/filters

Fetches users based on filters such as date range, project IDs, and agent interactions.

Purpose:

This endpoint allows the authenticated user to fetch users based on filters such as date range, project IDs, and agent interactions.

Query Parameters:

start_date (optional): ISO 8601 formatted date string to filter from. Defaults to 30 days ago if not provided.

end_date (optional): ISO 8601 formatted date string to filter to. Defaults to current date if not provided.

project_ids (optional): Comma-separated list or array of project IDs to filter users who interacted via chat.

agent_ids (optional): Comma-separated list or array of agent IDs to filter users who interacted via chat.

Returns:

200 OK: The users are fetched successfully.

400 Bad Request: If versioning fails or invalid parameters are passed.

500 Internal Server Error: On unhandled exceptions.

Current Version: 2.0.0

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "users": [
            {
                "id": 0,
                "email": "user@example.com"
            }
        ]
    }
}

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Success

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Get a specific User by user_email

Get authenticated User