Get workspace competitors
The brands this workspace measures itself against in AI answers: the tracked competitors plus, for reference, the workspace's own brand (`selfBrand`, `isSelf: true`).
Tool name: get_workspace_competitors
Cost: Free - not billed, and does not draw on a plan quota.
Read-only
This tool only reads. It never creates or changes anything, so an assistant may call it without asking you first.
The brands this workspace measures itself against in AI answers: the tracked competitors plus, for reference, the workspace's own brand (selfBrand, isSelf: true). Each carries the facts the detectors match on - aliases in answer text, domains and socialUrls in cited sources - plus measuredDays and lastMeasuredOn, which say whether the brand has any recorded history yet and what removing it would discard. A competitor added today reads 0 until the next monitoring run. Call this before set_workspace_competitors and edit from what it returns; that tool replaces each list wholesale. Takes a workspaceId, not a site - call list_workspaces if you only know the domain.
Parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
workspaceId | string (uuid) | Yes | - |
Full input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": ["workspaceId"]
}Response
Full output JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"selfBrand": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"aliases": {
"type": "array",
"items": {
"type": "string"
}
},
"domains": {
"type": "array",
"items": {
"type": "string"
}
},
"socialUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"employeeLinkedinUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"isSelf": {
"type": "boolean"
},
"measuredDays": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastMeasuredOn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"aliases",
"domains",
"socialUrls",
"employeeLinkedinUrls",
"isSelf",
"measuredDays"
],
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"competitors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"aliases": {
"type": "array",
"items": {
"type": "string"
}
},
"domains": {
"type": "array",
"items": {
"type": "string"
}
},
"socialUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"employeeLinkedinUrls": {
"type": "array",
"items": {
"type": "string"
}
},
"isSelf": {
"type": "boolean"
},
"measuredDays": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"lastMeasuredOn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"aliases",
"domains",
"socialUrls",
"employeeLinkedinUrls",
"isSelf",
"measuredDays"
],
"additionalProperties": {}
}
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"rejected": {
"type": "array",
"items": {
"type": "object",
"properties": {
"competitor": {
"type": "string"
},
"field": {
"type": "string"
},
"value": {
"type": "string"
},
"reason": {
"type": "string"
}
},
"required": ["competitor", "field", "value", "reason"],
"additionalProperties": {}
}
}
},
"required": ["workspaceId", "competitors", "limit", "rejected"],
"additionalProperties": false
}