freshworks · Schema

Branch

Properties

Name Type Description
id integer Unique ID of the branch.
name string Name of the branch.
city string City.
state string State or province.
country string Country.
zip string ZIP or postal code.
time_zone string Time zone.
currency string Local currency code.
main_office boolean Whether this is the main office.
date_format string Date format used at this branch.
created_at string Timestamp when created.
updated_at string Timestamp when last updated.
View JSON Schema on GitHub

JSON Schema

freshworks-branch-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Branch",
  "title": "Branch",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique ID of the branch."
    },
    "name": {
      "type": "string",
      "description": "Name of the branch."
    },
    "city": {
      "type": "string",
      "description": "City."
    },
    "state": {
      "type": "string",
      "description": "State or province."
    },
    "country": {
      "type": "string",
      "description": "Country."
    },
    "zip": {
      "type": "string",
      "description": "ZIP or postal code."
    },
    "time_zone": {
      "type": "string",
      "description": "Time zone."
    },
    "currency": {
      "type": "string",
      "description": "Local currency code."
    },
    "main_office": {
      "type": "boolean",
      "description": "Whether this is the main office."
    },
    "date_format": {
      "type": "string",
      "description": "Date format used at this branch."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when created."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when last updated."
    }
  }
}