freshworks · Schema

Company

Properties

Name	Type	Description
id	integer	Unique ID of the company.
name	string	Name of the company.
description	string	Description of the company.
note	string	Notes about the company.
domains	array	Email domains associated with the company.
health_score	string	Health score of the company account.
account_tier	string	Tier of the company account.
renewal_date	string	Date of account renewal.
industry	string	Industry sector of the company.
custom_fields	object	Key-value pairs for custom fields.
created_at	string	Timestamp when the company was created.
updated_at	string	Timestamp when the company was last updated.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Company",
  "title": "Company",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique ID of the company."
    },
    "name": {
      "type": "string",
      "description": "Name of the company."
    },
    "description": {
      "type": "string",
      "description": "Description of the company."
    },
    "note": {
      "type": "string",
      "description": "Notes about the company."
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Email domains associated with the company."
    },
    "health_score": {
      "type": "string",
      "description": "Health score of the company account."
    },
    "account_tier": {
      "type": "string",
      "description": "Tier of the company account."
    },
    "renewal_date": {
      "type": "string",
      "format": "date",
      "description": "Date of account renewal."
    },
    "industry": {
      "type": "string",
      "description": "Industry sector of the company."
    },
    "custom_fields": {
      "type": "object",
      "additionalProperties": true,
      "description": "Key-value pairs for custom fields."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the company was created."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the company was last updated."
    }
  }
}