Common Room · Schema

ApiObjectType

Community IntelligenceGo-to-MarketMember SignalsGitHubSlackDiscordLinkedInSales IntelligenceContact ManagementWebhooks

Properties

Name Type Description
id string Prefixed object type ID (format `cot_`)
name string The object type's display name
assocs array Associations to other entity types
View JSON Schema on GitHub

JSON Schema

common-room-v2-apiobjecttype-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.commonroom.io/schemas/v2/apiobjecttype",
  "title": "ApiObjectType",
  "type": "object",
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Prefixed object type ID (format `cot_<number>`)"
    },
    "name": {
      "type": "string",
      "description": "The object type's display name"
    },
    "assocs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ApiObjectTypeAssoc"
      },
      "description": "Associations to other entity types"
    }
  }
}