Chatwoot · Schema

Agent

Chatwoot Agent schema

Customer-SupportMessagingLive ChatOmnichannelConversationsContactsAgentsOpen-Source

Properties

Name Type Description
id integer
account_id integer
availability_status string The effective availability status of the agent, derived from the configured availability, auto-offline setting, and current presence. To update an agent's configured availability, use the availability
auto_offline boolean Whether the agent is automatically marked offline when they are away.
confirmed boolean Whether the agent has confirmed their email address.
email string The email of the agent
available_name string The available name of the agent
name string The name of the agent
role string The role of the agent
thumbnail string The thumbnail of the agent
custom_role_id integernull The custom role id of the agent
View JSON Schema on GitHub

JSON Schema

agent.json Raw ↑
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "account_id": {
      "type": "integer"
    },
    "availability_status": {
      "type": "string",
      "enum": [
        "online",
        "busy",
        "offline"
      ],
      "readOnly": true,
      "description": "The effective availability status of the agent, derived from the configured availability, auto-offline setting, and current presence. To update an agent's configured availability, use the availability field in create or update requests."
    },
    "auto_offline": {
      "type": "boolean",
      "description": "Whether the agent is automatically marked offline when they are away."
    },
    "confirmed": {
      "type": "boolean",
      "description": "Whether the agent has confirmed their email address."
    },
    "email": {
      "type": "string",
      "description": "The email of the agent"
    },
    "available_name": {
      "type": "string",
      "description": "The available name of the agent"
    },
    "name": {
      "type": "string",
      "description": "The name of the agent"
    },
    "role": {
      "type": "string",
      "enum": [
        "agent",
        "administrator"
      ],
      "description": "The role of the agent"
    },
    "thumbnail": {
      "type": "string",
      "description": "The thumbnail of the agent"
    },
    "custom_role_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The custom role id of the agent"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/chatwoot/main/json-schema/agent.json",
  "title": "Agent",
  "description": "Chatwoot Agent schema"
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/agent"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.