Get list of Recent Agents

GET

/api/v2/agents/recents

Retrieves a list of recent agents for the current user with support for search, sorting, and pagination.

Purpose:

Allows users to fetch their recently accessed agents with optional filters.

Supports pagination, name-based search, sorting, and a verbosity level that controls which agent fields are returned.

Query parameters are documented on RecentAgentListGetQuerySerializer_V2_2.

Returns:

A list of serialized recent agents based on applied filters.

Supports both paginated and unpaginated responses based on user preference.

A 400 Bad Request error if the version or query parameters are invalid.

A 500 Internal Server Error for any unexpected failures.

Current Version:

2.2.0

Changelog:

v2.2.0: Added verbosity query parameter ("low", "medium", "high"; default "high").
Default response is unchanged from v2.1.

v2.1.0: Added pagination, search, and sorting support. Response includes recent_agents
and meta. meta contains count, current_page, and num_pages when paginated=true,
otherwise null.

v2.0.0: Initial endpoint. Returns a list of recent agents for the authenticated user.

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Success. data takes one of three shapes depending on verbosity (low, medium, high).

Bodyapplication/json

🟠400Bad Request

🟠403Record Not Found

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/agents/recents?items_per_page=&page=&paginated=&published_as_teammate=&query=&sort_by=&verbosity=' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "recent_agents": [
            {
                "id": 0,
                "agent": {
                    "id": 0,
                    "agent_name": "string",
                    "agent_image": "string",
                    "status": "string",
                    "is_published_as_teammate": true
                },
                "created_on": "2019-08-24T14:15:22.123Z",
                "modified_on": "2019-08-24T14:15:22.123Z"
            }
        ],
        "meta": {
            "count": 0,
            "num_pages": 0,
            "current_page": 0
        }
    }
}

Get all Agents by Project

Get all Starred Agents of the Authenticated User