Chatwoot · Schema

User

Chatwoot User schema

Customer-SupportMessagingLive ChatOmnichannelConversationsContactsAgentsOpen-Source

Properties

Name Type Description
id number
access_token string
account_id number
available_name string
avatar_url string
confirmed boolean
display_name stringnull
message_signature stringnull
email string
hmac_identifier string
inviter_id numbernull
name string
provider string
pubsub_token string
role string
ui_settings object
uid string
type stringnull
custom_attributes object Available for users who are created through platform APIs and has custom attributes associated.
accounts array
View JSON Schema on GitHub

JSON Schema

user.json Raw ↑
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "access_token": {
      "type": "string"
    },
    "account_id": {
      "type": "number"
    },
    "available_name": {
      "type": "string"
    },
    "avatar_url": {
      "type": "string"
    },
    "confirmed": {
      "type": "boolean"
    },
    "display_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "message_signature": {
      "type": [
        "string",
        "null"
      ]
    },
    "email": {
      "type": "string"
    },
    "hmac_identifier": {
      "type": "string"
    },
    "inviter_id": {
      "type": [
        "number",
        "null"
      ]
    },
    "name": {
      "type": "string"
    },
    "provider": {
      "type": "string"
    },
    "pubsub_token": {
      "type": "string"
    },
    "role": {
      "type": "string",
      "enum": [
        "agent",
        "administrator"
      ]
    },
    "ui_settings": {
      "type": "object"
    },
    "uid": {
      "type": "string"
    },
    "type": {
      "type": [
        "string",
        "null"
      ]
    },
    "custom_attributes": {
      "type": "object",
      "description": "Available for users who are created through platform APIs and has custom attributes associated."
    },
    "accounts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "active_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "role": {
            "type": "string",
            "enum": [
              "administrator",
              "agent"
            ]
          },
          "permissions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "availability": {
            "type": "string"
          },
          "availability_status": {
            "type": "string"
          },
          "auto_offline": {
            "type": "boolean"
          },
          "custom_role_id": {
            "type": [
              "number",
              "null"
            ]
          },
          "custom_role": {
            "type": [
              "object",
              "null"
            ]
          }
        }
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/chatwoot/main/json-schema/user.json",
  "title": "User",
  "description": "Chatwoot User 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/user"
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.