freshworks · Schema

User

Properties

Name Type Description
id integer Unique ID of the user.
name string Full name of the user.
email string Email address.
phone string Phone number.
role string Role of the user (admin, supervisor, agent).
available boolean Whether the user is currently available.
team_ids array IDs of teams the user belongs to.
created_at string Timestamp when created.
updated_at string Timestamp when last updated.
View JSON Schema on GitHub

JSON Schema

freshworks-user-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/User",
  "title": "User",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique ID of the user."
    },
    "name": {
      "type": "string",
      "description": "Full name of the user."
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address."
    },
    "phone": {
      "type": "string",
      "description": "Phone number."
    },
    "role": {
      "type": "string",
      "description": "Role of the user (admin, supervisor, agent)."
    },
    "available": {
      "type": "boolean",
      "description": "Whether the user is currently available."
    },
    "team_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "IDs of teams the user belongs to."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when created."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when last updated."
    }
  }
}