Common Room · Schema

ApiSegment

Community IntelligenceGo-to-MarketMember SignalsGitHubSlackDiscordLinkedInSales IntelligenceContact ManagementWebhooks

Properties

Name Type Description
id string Prefixed segment ID (format `s_`)
name string The segment's display name
entityType string The type of entity this segment contains
entityCount integer Number of entities in this segment
url string Common Room URL for this segment
View JSON Schema on GitHub

JSON Schema

common-room-v2-apisegment-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.commonroom.io/schemas/v2/apisegment",
  "title": "ApiSegment",
  "type": "object",
  "required": [
    "id",
    "name",
    "entityType"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Prefixed segment ID (format `s_<number>`)"
    },
    "name": {
      "type": "string",
      "description": "The segment's display name"
    },
    "entityType": {
      "type": "string",
      "enum": [
        "contact",
        "object",
        "organization"
      ],
      "description": "The type of entity this segment contains"
    },
    "entityCount": {
      "type": "integer",
      "description": "Number of entities in this segment"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Common Room URL for this segment"
    }
  }
}