Common Room · Schema

ApiLocationItem

Community IntelligenceGo-to-MarketMember SignalsGitHubSlackDiscordLinkedInSales IntelligenceContact ManagementWebhooks

Properties

Name Type Description
id string Prefixed location ID
name string Display name for the location
type string The granularity of this location
city string
region string
country string
View JSON Schema on GitHub

JSON Schema

common-room-v2-apilocationitem-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.commonroom.io/schemas/v2/apilocationitem",
  "title": "ApiLocationItem",
  "type": "object",
  "required": [
    "id",
    "name",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Prefixed location ID"
    },
    "name": {
      "type": "string",
      "description": "Display name for the location"
    },
    "type": {
      "type": "string",
      "enum": [
        "city",
        "country",
        "country_region",
        "world_region"
      ],
      "description": "The granularity of this location"
    },
    "city": {
      "type": "string"
    },
    "region": {
      "type": "string"
    },
    "country": {
      "type": "string"
    }
  }
}