Chatwoot · Schema

User

Chatwoot User schema

Customer SupportMessagingLive ChatOmni-channelConversationsContactsAgentsOpen 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

{
  "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"
}