Sign in

v1

latestOpenAPI 3.0.02026-07-263365159.1 KB

get/api/v1/external/agents

Query parameters

type'all' | 'doctype' | 'casetype'

The type of agents to retrieve. Allowed values: all, document, case.

Headers

apikeystring required

API key used for authentication. You can find your API key in your account settings.

Response

Success.

errorstring
error_codestring
messagestring
statusstring
status_codeinteger

Example response

{
  "data": {
    "agents": [
      {
        "org_id": "695cad157a9939d618905086",
        "casetype_id": "others__1y7ud",
        "casetype_name": "Custom",
        "case_status_counts": {
          "all": 2,
          "processed": 2
        },
        "agent_type": "casetype"
      }
    ]
  },
  "message": "Agents retrieved successfully",
  "status": "success",
  "status_code": 200
}