Skip to main content

Retrieves a list of agents with additional name details based on the provided filter criteria

POST /v1/agent/list

Summary​

Retrieves a list of agents with additional name details based on the provided filter criteria.

Details​

Request body: JSON object.

Returns a list of agents with additional name details.

Authentication​

No operation-level security requirement is documented here.

Parameters​

None documented here.

Request Body​

Required: Yes

application/json​

  • deviceID (integer (int64), optional)
  • startDate (string (date-time), optional)
  • endDate (string (date-time), optional)
  • count (integer (int64), optional)
  • order (string, optional)

Example

{
  "deviceID": 201,
  "startDate": "2026-03-30T12:00:00.0000000Z",
  "endDate": "2026-03-30T12:00:00.0000000Z",
  "count": 25,
  "order": "Example value"
}

Responses​

200​

Success

text/plain​

  • array of Agent
    • key (integer (int64), optional)
    • deviceID (integer (int64), optional)
    • agentTypeID (integer (int64), optional)
    • agentIndex (integer (int64), optional)
    • currentEventID (integer (int64), optional)
    • processID (integer (int64), optional)
    • version (string, optional)
    • agentName (string, optional)
    • agentDescription (string, optional)
    • recentOutput (string, optional)
    • lastHeardFromDate (string (date-time), optional)
    • creationDate (string (date-time), optional)

Example

[
  {
    "key": 1,
    "userID": 101,
    "deviceID": 201,
    "agentTypeID": 1,
    "agentIndex": 1,
    "currentEventID": 501,
    "processID": 4321,
    "version": "1.0.0",
    "agentName": "Example value",
    "agentDescription": "Example description",
    "recentOutput": "Agent started successfully.",
    "lastHeardFromDate": "2026-03-30T12:00:00.0000000Z",
    "creationDate": "2026-03-30T12:00:00.0000000Z",
    "createdBy": 1,
    "lastModifiedDate": "2026-03-30T12:00:00.0000000Z",
    "lastModifiedBy": 1
  }
]

application/json​

  • array of Agent
    • key (integer (int64), optional)
    • deviceID (integer (int64), optional)
    • agentTypeID (integer (int64), optional)
    • agentIndex (integer (int64), optional)
    • currentEventID (integer (int64), optional)
    • processID (integer (int64), optional)
    • version (string, optional)
    • agentName (string, optional)
    • agentDescription (string, optional)
    • recentOutput (string, optional)
    • lastHeardFromDate (string (date-time), optional)
    • creationDate (string (date-time), optional)

Example

[
  {
    "key": 1,
    "deviceID": 201,
    "agentTypeID": 1,
    "agentIndex": 1,
    "currentEventID": 501,
    "processID": 4321,
    "version": "1.0.0",
    "agentName": "Example value",
    "agentDescription": "Example description",
    "recentOutput": "Agent started successfully.",
    "lastHeardFromDate": "2026-03-30T12:00:00.0000000Z",
    "creationDate": "2026-03-30T12:00:00.0000000Z",
    "deviceName": "WearableDevice",
    "agentType": "Device"
  }
]

text/json​

  • array of Agent
    • key (integer (int64), optional)
    • deviceID (integer (int64), optional)
    • agentTypeID (integer (int64), optional)
    • agentIndex (integer (int64), optional)
    • currentEventID (integer (int64), optional)
    • processID (integer (int64), optional)
    • version (string, optional)
    • agentName (string, optional)
    • agentDescription (string, optional)
    • recentOutput (string, optional)
    • lastHeardFromDate (string (date-time), optional)
    • creationDate (string (date-time), optional)

Example

[
  {
    "key": 1,
    "userID": 101,
    "deviceID": 201,
    "agentTypeID": 1,
    "agentIndex": 1,
    "currentEventID": 501,
    "processID": 4321,
    "version": "1.0.0",
    "agentName": "Example value",
    "agentDescription": "Example description",
    "recentOutput": "Agent started successfully.",
    "lastHeardFromDate": "2026-03-30T12:00:00.0000000Z",
    "creationDate": "2026-03-30T12:00:00.0000000Z",
    "createdBy": 1,
    "lastModifiedDate": "2026-03-30T12:00:00.0000000Z",
    "lastModifiedBy": 1
  }
]