{ "openapi": "3.1.0", "info": { "title": "Dench API", "version": "1.0.0", "description": "Versioned Dench workspace API. The operation registry is shared with the Dench CLI parity layer, so every CLI command maps to an endpoint here." }, "servers": [ { "url": "https://www.dench.com/api/v1" } ], "tags": [ { "name": "agent-config", "description": "Agent Config operations." }, { "name": "approvals", "description": "Approvals operations." }, { "name": "apps", "description": "Apps operations." }, { "name": "auth", "description": "Auth operations." }, { "name": "billing", "description": "Billing operations." }, { "name": "browser", "description": "Browser operations." }, { "name": "campaigns", "description": "Campaigns operations." }, { "name": "chat", "description": "Chat operations." }, { "name": "crm", "description": "Crm operations." }, { "name": "email", "description": "Email operations." }, { "name": "environments", "description": "Environments operations." }, { "name": "files", "description": "Files operations." }, { "name": "gateway", "description": "Gateway operations." }, { "name": "lists", "description": "Lists operations." }, { "name": "local", "description": "Local operations." }, { "name": "meetings", "description": "Meetings operations." }, { "name": "members", "description": "Members operations." }, { "name": "memory", "description": "Memory operations." }, { "name": "meta", "description": "Meta operations." }, { "name": "notifications", "description": "Notifications operations." }, { "name": "routines", "description": "Routines operations." }, { "name": "secrets", "description": "Secrets operations." }, { "name": "settings", "description": "Settings operations." }, { "name": "workspace", "description": "Workspace operations." } ], "paths": { "/environments": { "get": { "operationId": "environments_list", "tags": [ "environments" ], "summary": "List workspace-shared reusable setups and ready revisions (metadata only)", "description": "List workspace-shared reusable setups and ready revisions (metadata only).", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/environments/{name}": { "get": { "operationId": "environments_get", "tags": [ "environments" ], "summary": "Inspect a saved setup, its manifest, and an optional immutable revision", "description": "Inspect a saved setup, its manifest, and an optional immutable revision.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" } }, { "name": "revision", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "operationId": "environments_save", "tags": [ "environments" ], "summary": "Publish an explicitly saved source and manifest for one-time preparation. Returns pending/building until verified; does not run the task", "description": "Publish an explicitly saved source and manifest for one-time preparation. Returns pending/building until verified; does not run the task.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "manifest": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "name": { "type": "string" }, "purpose": { "type": "string" }, "files": { "type": "array", "items": { "type": "string" } }, "prepare": { "type": "array", "items": { "type": "string" } }, "verify": { "type": "array", "items": { "type": "string" } }, "env": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "secretEnv": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "secretFiles": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "secret": { "type": "string" }, "mutable": { "type": "boolean" } }, "required": [ "path", "secret" ], "additionalProperties": false } }, "statePaths": { "type": "array", "items": { "type": "string" } }, "portable": { "type": "boolean" } }, "required": [ "version", "name", "purpose", "files", "prepare", "verify" ], "additionalProperties": false }, "uploadId": { "type": "string" }, "storageId": { "type": "string" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "manifest", "uploadId", "storageId", "sha256" ] }, "example": { "manifest": {}, "uploadId": "string", "storageId": "string", "sha256": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "delete": { "operationId": "environments_delete", "tags": [ "environments" ], "summary": "Retire a saved setup from new selection; retain immutable revisions and active job evidence", "description": "Retire a saved setup from new selection; retain immutable revisions and active job evidence.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/environments/uploads": { "post": { "operationId": "environments_upload", "tags": [ "environments" ], "summary": "Reserve an owner-bound source upload. Prefix the uploaded bytes with the returned proof before saving", "description": "Reserve an owner-bound source upload. Prefix the uploaded bytes with the returned proof before saving.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "kind": { "type": "string", "const": "source" }, "size": { "type": "integer", "minimum": 1, "maximum": 16777216 }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "kind", "size", "sha256" ] }, "example": { "kind": "string", "size": 0, "sha256": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/local/environments/run": { "post": { "operationId": "environments_run", "tags": [ "environments" ], "summary": "Run a command with prepared dependencies and declared credentials, saving declared state with a revision check", "description": "Run a command with prepared dependencies and declared credentials, saving declared state with a revision check.", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Local-only CLI operation. Execution occurs in the CLI process. Use dench env run NAME -- COMMAND; secret-bearing execution resolution is not a general REST read endpoint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "error": { "message": "Execution occurs in the CLI process. Use dench env run NAME -- COMMAND; secret-bearing execution resolution is not a general REST read endpoint.", "type": "invalid_request_error", "code": "local_only" } } } } }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/secrets": { "get": { "operationId": "secrets_list", "tags": [ "secrets" ], "summary": "List workspace-shared credential names, kinds and versions; never values", "description": "List workspace-shared credential names, kinds and versions; never values.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/secrets/{name}": { "put": { "operationId": "secrets_set", "tags": [ "secrets" ], "summary": "Encrypt a workspace credential. Use CLI stdin or the secure chat form; return metadata only. Do not put values in chat, manifests or scripts", "description": "Encrypt a workspace credential. Use CLI stdin or the secure chat form; return metadata only. Do not put values in chat, manifests or scripts.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Z][A-Z0-9_]{0,127}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "env", "file" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 65536 }, "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "kind", "value" ] }, "example": { "kind": "env", "value": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "kind": { "type": "string", "enum": [ "env", "file" ] }, "version": { "type": "number" }, "revision": { "type": "number" }, "status": { "type": "string", "const": "stored" } }, "required": [ "name", "kind", "version", "revision", "status" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "delete": { "operationId": "secrets_delete", "tags": [ "secrets" ], "summary": "Revoke a workspace credential for future resolution, optionally checking its version", "description": "Revoke a workspace credential for future resolution, optionally checking its version.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Z][A-Z0-9_]{0,127}$" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } } } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/drafts": { "post": { "operationId": "campaigns_drafts_create", "tags": [ "campaigns" ], "summary": "Create an idempotent empty campaign draft with the caller's available sender pools. Does not launch or send", "description": "Create an idempotent empty campaign draft with the caller's available sender pools. Does not launch or send.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "clientRequestId": { "type": "string", "minLength": 8, "maxLength": 64, "description": "Your stable id for this request, 8-64 characters. Retrying with the same id returns the same draft instead of creating another." }, "name": { "type": "string", "maxLength": 120 }, "timezone": { "description": "IANA timezone, e.g. America/Los_Angeles. Sets a Mon-Fri 9-18 send window in it; without one the draft has no send window.", "type": "string" }, "emailMailboxAccountIds": { "description": "Mailboxes to send from instead of your own running ones. Checked as the draft is created: one you can't use creates nothing.", "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1 } }, "linkedinAccountIds": { "description": "LinkedIn accounts to send from instead of your own running ones. Checked as the draft is created.", "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "clientRequestId" ] }, "example": { "clientRequestId": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "sequenceId": { "type": "string" }, "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false } }, "required": [ "sequenceId" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/audience/search": { "post": { "operationId": "campaigns_audience_search", "tags": [ "campaigns" ], "summary": "Search people by filters without adding CRM records or campaign recipients. Search credits apply; this is not a free provider preview", "description": "Search people by filters without adding CRM records or campaign recipients. Search credits apply; this is not a free provider preview.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sequenceId": { "type": "string" }, "filters": { "type": "object", "properties": { "linkedinUrl": { "type": "string" }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "keywords": { "description": "Current-title text only. For profile or work descriptions, use profileKeywords. Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "type": "string" }, "companyDomain": { "type": "string" }, "companyName": { "type": "string" }, "titles": { "description": "Current job titles (free text). Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "pastTitles": { "description": "Past job titles (free text).", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "personNames": { "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "pastSeniorities": { "description": "Seniority in any past role, independent of pastCompanyNames/pastTitles. Current seniority vocabulary plus Founding Team. Founder includes Co-Founder; C-level and Founding Team do not imply founder. Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "profileKeywords": { "description": "Text in headline/about or any current/past work description. OR includes, global exclusions. Always loose text matching; missing evidence does not match.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "companyKeywords": { "description": "Current employer business focus/model (e.g. SaaS, B2B, Cloud), from description/tagline/business tags; distinct from legal companyTypes. Same employer as other current-job filters. Always loose text matching. May need another filter to retrieve candidates.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "seniorities": { "description": "Exact enum: Owner, Founder, C-level, Partner, VP, Head, Director, Manager, Senior.", "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "jobFunctions": { "description": "Exact enum, e.g. Sales, Marketing, Software. Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "subFunctions": { "description": "Exact enum, e.g. SDR/BDR, Demand Generation. Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "industries": { "description": "Exact enum, e.g. Software Development. Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "locations": { "description": "Person locations — cities, states, countries, or metros (free text). Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "headcountRanges": { "description": "Exact buckets: 1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001+.", "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "companyNames": { "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "pastCompanyNames": { "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "companyDomains": { "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "companyHeadquarters": { "description": "Company HQ locations — cities, states, countries, or metros (free text). Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "companyTypes": { "description": "Exact enum: Partnership, Nonprofit, Educational, Privately Held, Public Company, Self-Owned, Self-Employed, Government Agency.", "maxItems": 10, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "universities": { "description": "Universities attended (free text). Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "skills": { "description": "Profile skills (free text). Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "languages": { "description": "Spoken languages, e.g. English, German. Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "yearsInRole": { "type": "object", "properties": { "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "yearsAtCompany": { "type": "object", "properties": { "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "daysSinceJobChange": { "type": "object", "properties": { "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "foundedYears": { "description": "Company founded-year range, e.g. {min: 2015, max: 2024}.", "type": "object", "properties": { "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "exactMatch": { "description": "Match free-text filters as whole strings. Default false: titles ['Founder'] also returns 'Co-Founder' and 'Founder & CEO'. Set true to narrow. Domains, LinkedIn URLs, enum filters and numeric ranges are always exact; keywords is always a loose text probe.", "type": "boolean" }, "preferCache": { "type": "boolean" } }, "additionalProperties": false }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "pageToken": { "type": "string" } }, "required": [ "filters" ] }, "example": { "filters": {} } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "people": { "type": "array", "items": {} }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "linkedinProfileUrl": { "type": "string" }, "displayName": { "type": "string" }, "personalization": { "description": "Merge values keyed by name, e.g. {\"Company\":\"Acme\"} for {{Company}}.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "additionalProperties": false, "description": "One person. Needs email and/or linkedinProfileUrl; unknown keys are rejected, not dropped." } }, "metadata": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "estimatedCents": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The search cost ceiling reported by Dench billing, in cents. Null means the receipt is unavailable." }, "chargedCents": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The actual search charge reported by Dench billing, in cents. Null means the receipt is unavailable; results remain valid." } }, "required": [ "rows", "people", "recipients", "metadata", "estimatedCents", "chargedCents" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/{sequenceId}/people/search": { "post": { "operationId": "campaigns_people_addFromSearch", "tags": [ "campaigns" ], "summary": "Search and add up to 50 people to an existing campaign. New identities become Leads. Search credits apply; use nextPageToken for another page", "description": "Search and add up to 50 people to an existing campaign. New identities become Leads. Search credits apply; use nextPageToken for another page.", "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "object", "properties": { "linkedinUrl": { "type": "string" }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "keywords": { "description": "Current-title text only. For profile or work descriptions, use profileKeywords. Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "type": "string" }, "companyDomain": { "type": "string" }, "companyName": { "type": "string" }, "titles": { "description": "Current job titles (free text). Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "pastTitles": { "description": "Past job titles (free text).", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "personNames": { "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "pastSeniorities": { "description": "Seniority in any past role, independent of pastCompanyNames/pastTitles. Current seniority vocabulary plus Founding Team. Founder includes Co-Founder; C-level and Founding Team do not imply founder. Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "profileKeywords": { "description": "Text in headline/about or any current/past work description. OR includes, global exclusions. Always loose text matching; missing evidence does not match.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "companyKeywords": { "description": "Current employer business focus/model (e.g. SaaS, B2B, Cloud), from description/tagline/business tags; distinct from legal companyTypes. Same employer as other current-job filters. Always loose text matching. May need another filter to retrieve candidates.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "seniorities": { "description": "Exact enum: Owner, Founder, C-level, Partner, VP, Head, Director, Manager, Senior.", "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "jobFunctions": { "description": "Exact enum, e.g. Sales, Marketing, Software. Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "subFunctions": { "description": "Exact enum, e.g. SDR/BDR, Demand Generation. Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "industries": { "description": "Exact enum, e.g. Software Development. Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "locations": { "description": "Person locations — cities, states, countries, or metros (free text). Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "headcountRanges": { "description": "Exact buckets: 1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10001+.", "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "companyNames": { "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "pastCompanyNames": { "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "companyDomains": { "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "companyHeadquarters": { "description": "Company HQ locations — cities, states, countries, or metros (free text). Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "companyTypes": { "description": "Exact enum: Partnership, Nonprofit, Educational, Privately Held, Public Company, Self-Owned, Self-Employed, Government Agency.", "maxItems": 10, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "universities": { "description": "Universities attended (free text). Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "skills": { "description": "Profile skills (free text). Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 50, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "languages": { "description": "Spoken languages, e.g. English, German. Accepted values: see `dench leads filters` or https://dench.com/references/find-filter-options.json.", "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "value": { "type": "string" }, "exclude": { "type": "boolean" }, "exactMatch": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false } ] } }, "yearsInRole": { "type": "object", "properties": { "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "yearsAtCompany": { "type": "object", "properties": { "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "daysSinceJobChange": { "type": "object", "properties": { "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "foundedYears": { "description": "Company founded-year range, e.g. {min: 2015, max: 2024}.", "type": "object", "properties": { "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "exactMatch": { "description": "Match free-text filters as whole strings. Default false: titles ['Founder'] also returns 'Co-Founder' and 'Founder & CEO'. Set true to narrow. Domains, LinkedIn URLs, enum filters and numeric ranges are always exact; keywords is always a loose text probe.", "type": "boolean" }, "preferCache": { "type": "boolean" } }, "additionalProperties": false }, "limit": { "type": "integer", "minimum": 1, "maximum": 50 }, "pageToken": { "type": "string" }, "checkDuplicatesAcrossWorkspace": { "type": "boolean" } }, "required": [ "filters" ] }, "example": { "filters": {} } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "people": { "type": "array", "items": {} }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "linkedinProfileUrl": { "type": "string" }, "displayName": { "type": "string" }, "personalization": { "description": "Merge values keyed by name, e.g. {\"Company\":\"Acme\"} for {{Company}}.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "additionalProperties": false, "description": "One person. Needs email and/or linkedinProfileUrl; unknown keys are rejected, not dropped." } }, "metadata": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "estimatedCents": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The search cost ceiling reported by Dench billing, in cents. Null means the receipt is unavailable." }, "chargedCents": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The actual search charge reported by Dench billing, in cents. Null means the receipt is unavailable; results remain valid." }, "added": { "type": "number" }, "requested": { "type": "number" }, "cappedAtLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duplicates": { "type": "number" }, "duplicatesElsewhere": { "type": "number" }, "suppressed": { "type": "number" }, "invalid": { "type": "number" }, "skippedNoIdentity": { "type": "number" }, "skippedMissingInfo": { "type": "number" }, "missingInfoSample": {}, "found": { "type": "number" }, "skippedSearchProfiles": { "type": "number" } }, "required": [ "rows", "people", "recipients", "metadata", "estimatedCents", "chargedCents", "added", "requested", "cappedAtLimit", "duplicates", "duplicatesElsewhere", "suppressed", "invalid", "skippedNoIdentity", "skippedMissingInfo", "found", "skippedSearchProfiles" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/{sequenceId}/people/batch": { "post": { "operationId": "campaigns_people_addBatch", "tags": [ "campaigns" ], "summary": "Add up to 50 selected recipients without another search. Deduplicates, applies suppression, and preserves the campaign's launch state", "description": "Add up to 50 selected recipients without another search. Deduplicates, applies suppression, and preserves the campaign's launch state.", "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "recipients": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "linkedinProfileUrl": { "type": "string" }, "displayName": { "type": "string" }, "personalization": { "description": "Merge values keyed by name, e.g. {\"Company\":\"Acme\"} for {{Company}}.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "additionalProperties": false, "description": "One person. Needs email and/or linkedinProfileUrl; unknown keys are rejected, not dropped." } }, "newRecordsObject": { "type": "string", "enum": [ "lead", "people" ] }, "checkDuplicatesAcrossWorkspace": { "type": "boolean" } }, "required": [ "recipients" ] }, "example": { "recipients": [] } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "added": { "type": "number" }, "requested": { "type": "number" }, "cappedAtLimit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duplicates": { "type": "number" }, "duplicatesElsewhere": { "type": "number" }, "suppressed": { "type": "number" }, "invalid": { "type": "number" }, "skippedNoIdentity": { "type": "number" }, "skippedMissingInfo": { "type": "number" }, "missingInfoSample": {} }, "required": [ "added", "requested", "cappedAtLimit", "duplicates", "duplicatesElsewhere", "suppressed", "invalid", "skippedNoIdentity", "skippedMissingInfo" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/{sequenceId}/sources": { "get": { "operationId": "campaigns_sources_get", "tags": [ "campaigns" ], "summary": "Read a campaign's saved signal source, targeting and schedule", "description": "Read a campaign's saved signal source, targeting and schedule.", "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "patch": { "operationId": "campaigns_sources_update", "tags": [ "campaigns" ], "summary": "Update source cadence, pause/resume, targeting, signals or terms. Active sources may perform billable future work", "description": "Update source cadence, pause/resume, targeting, signals or terms. Active sources may perform billable future work.", "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "active", "paused" ] }, "cadence": { "type": "string", "enum": [ "daily", "weekly", "monthly" ] }, "findMoreMatching": { "type": "boolean" }, "approvalMode": { "type": "string", "enum": [ "auto", "manual" ], "description": "auto: new people a signal finds start the sequence on their own. manual: they wait for approval." }, "targeting": { "type": "object", "properties": { "titles": { "type": "array", "items": { "type": "string" } }, "locations": { "type": "array", "items": { "type": "string" } }, "companySizes": { "type": "array", "items": { "type": "string" } }, "industries": { "type": "array", "items": { "type": "string" } }, "excludes": { "type": "array", "items": { "type": "string" } }, "companies": { "type": "array", "items": { "type": "string" } }, "companyTypes": { "type": "array", "items": { "type": "string" } } }, "required": [ "titles", "locations", "companySizes", "industries", "excludes" ], "additionalProperties": false }, "signal": { "type": "object", "properties": { "signal": { "type": "string", "enum": [ "post_engagement", "keyword", "hiring", "funding", "launch", "new_leader", "voice_engagement", "company_engagement", "brand_engagement", "lookalike" ] }, "enabled": { "type": "boolean" } }, "required": [ "signal", "enabled" ], "additionalProperties": false }, "terms": { "type": "object", "properties": { "signal": { "type": "string", "enum": [ "post_engagement", "keyword", "hiring", "voice_engagement", "company_engagement", "brand_engagement" ] }, "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "signal", "values" ], "additionalProperties": false } } } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "null" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/{sequenceId}/sources/signals": { "get": { "operationId": "campaigns_sources_signals", "tags": [ "campaigns" ], "summary": "Read signal choices, suggested terms and current source configuration", "description": "Read signal choices, suggested terms and current source configuration.", "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/{sequenceId}/sources/preview": { "post": { "operationId": "campaigns_sources_preview", "tags": [ "campaigns" ], "summary": "Preview a signal source using its current audience. Provider credits may apply; does not enroll people", "description": "Preview a signal source using its current audience. Provider credits may apply; does not enroll people.", "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "signal": { "type": "string", "enum": [ "post_engagement", "keyword", "hiring", "funding", "launch", "new_leader", "voice_engagement", "company_engagement", "brand_engagement", "lookalike" ] }, "terms": { "type": "array", "items": { "type": "string" } } }, "required": [ "signal" ] }, "example": { "signal": "post_engagement" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/{sequenceId}/sources/run": { "post": { "operationId": "campaigns_sources_run", "tags": [ "campaigns" ], "summary": "Run a live campaign's signals now instead of waiting for the schedule (Run now). Provider credits apply; limited to 6 runs an hour", "description": "Run a live campaign's signals now instead of waiting for the schedule (Run now). Provider credits apply; limited to 6 runs an hour.", "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "null" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/{sequenceId}/sources/overview": { "get": { "operationId": "campaigns_sources_overview", "tags": [ "campaigns" ], "summary": "Read the Sources tab: each signal's status, last and next run, people found and anything needing attention", "description": "Read the Sources tab: each signal's status, last and next run, people found and anything needing attention.", "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/{sequenceId}/sources/pending": { "get": { "operationId": "campaigns_sources_pending", "tags": [ "campaigns" ], "summary": "List people a signal found who are waiting for approval (manual approval mode)", "description": "List people a signal found who are waiting for approval (manual approval mode).", "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/{sequenceId}/sources/review": { "post": { "operationId": "campaigns_sources_review", "tags": [ "campaigns" ], "summary": "Approve people waiting for review (they start the sequence) or reject them", "description": "Approve people waiting for review (they start the sequence) or reject them.", "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enrollmentIds": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "decision": { "type": "string", "enum": [ "approve", "reject" ] } }, "required": [ "enrollmentIds", "decision" ] }, "example": { "enrollmentIds": [], "decision": "approve" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/{sequenceId}/queue": { "get": { "operationId": "campaigns_queue", "tags": [ "campaigns" ], "summary": "Today's queue: who the campaign plans to contact today, warmest first, within the senders' limits", "description": "Today's queue: who the campaign plans to contact today, warmest first, within the senders' limits.", "parameters": [ { "name": "sequenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/builder/profile": { "get": { "operationId": "campaigns_builder_profile", "tags": [ "campaigns" ], "summary": "Read the company profile and suggested campaign audience", "description": "Read the company profile and suggested campaign audience.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "hasProfile": { "type": "boolean" }, "targeting": { "type": "object", "properties": { "titles": { "type": "array", "items": { "type": "string" } }, "locations": { "type": "array", "items": { "type": "string" } }, "companySizes": { "type": "array", "items": { "type": "string" } }, "industries": { "type": "array", "items": { "type": "string" } }, "excludes": { "type": "array", "items": { "type": "string" } }, "companies": { "type": "array", "items": { "type": "string" } }, "companyTypes": { "type": "array", "items": { "type": "string" } } }, "required": [ "titles", "locations", "companySizes", "industries", "excludes" ], "additionalProperties": false } }, "required": [ "hasProfile", "targeting" ], "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/builder/drafts": { "post": { "operationId": "campaigns_builder_save", "tags": [ "campaigns" ], "summary": "Save a signal campaign's audience, signals and terms idempotently. Does not start a build", "description": "Save a signal campaign's audience, signals and terms idempotently. Does not start a build.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "clientRequestId": { "type": "string", "minLength": 8, "maxLength": 64, "description": "Your stable id for this request, 8-64 characters. Retrying with the same id returns the same draft instead of creating another." }, "targeting": { "type": "object", "properties": { "titles": { "type": "array", "items": { "type": "string" } }, "locations": { "type": "array", "items": { "type": "string" } }, "companySizes": { "type": "array", "items": { "type": "string" } }, "industries": { "type": "array", "items": { "type": "string" } }, "excludes": { "type": "array", "items": { "type": "string" } }, "companies": { "type": "array", "items": { "type": "string" } }, "companyTypes": { "type": "array", "items": { "type": "string" } } }, "required": [ "titles", "locations", "companySizes", "industries", "excludes" ], "additionalProperties": false }, "signals": { "type": "array", "items": { "type": "string", "enum": [ "post_engagement", "keyword", "hiring", "funding", "launch", "new_leader", "voice_engagement", "company_engagement", "brand_engagement", "lookalike" ] } }, "signalTerms": { "type": "object", "properties": { "post_engagement": { "description": "Post topics, phrased as what the buyer does (\"using AI for outbound\"), not bare product names.", "type": "array", "items": { "type": "string" } }, "keyword": { "type": "array", "items": { "type": "string" } }, "hiring": { "description": "Roles being hired for.", "type": "array", "items": { "type": "string" } }, "voice_engagement": { "description": "LinkedIn profile URLs of market voices whose posts to watch.", "type": "array", "items": { "type": "string" } }, "company_engagement": { "description": "LinkedIn company page URLs of companies and competitors.", "type": "array", "items": { "type": "string" } }, "brand_engagement": { "description": "The sender's own LinkedIn company page URL.", "type": "array", "items": { "type": "string" } }, "exact": { "description": "Topic signals searched by their exact keywords only (no drafted phrases).", "type": "array", "items": { "type": "string", "enum": [ "post_engagement", "keyword" ] } } }, "additionalProperties": false }, "findMoreMatching": { "description": "Also add people who match the audience without a signal.", "type": "boolean" }, "name": { "type": "string", "maxLength": 120 }, "source": { "type": "string", "enum": [ "signals", "lookalike", "existing", "crm", "search" ], "description": "How people come in: buying signals, people like one best lead, a pasted list or CSV, CRM records, or a people search." }, "screen": { "type": "string", "enum": [ "source", "signals", "lookalike", "target", "messages", "outreach", "review" ] }, "lookalike": { "description": "For source lookalike: the edited result of builder lookalike, with signals [\"lookalike\"].", "type": "object", "properties": { "seed": { "type": "object", "properties": { "name": { "type": "string" }, "linkedinUrl": { "type": "string" }, "title": { "type": "string" }, "companyName": { "type": "string" }, "companyDomain": { "type": "string" }, "avatarUrl": { "type": "string" } }, "required": [ "name", "linkedinUrl" ], "additionalProperties": false }, "title": { "type": "string" }, "similarRoles": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "location": { "type": "string" }, "industry": { "type": "string" }, "relatedIndustries": { "type": "boolean" }, "industries": { "type": "array", "items": { "type": "string" } }, "companySizes": { "type": "array", "items": { "type": "string" } }, "companies": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "name", "domain" ], "additionalProperties": false } } }, "required": [ "seed", "title", "similarRoles", "roles", "relatedIndustries", "industries", "companySizes", "companies" ], "additionalProperties": false } }, "required": [ "clientRequestId", "targeting", "signals" ] }, "example": { "clientRequestId": "string", "targeting": {}, "signals": [] } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "draftId": { "type": "string" } }, "required": [ "draftId" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "get": { "operationId": "campaigns_builder_drafts", "tags": [ "campaigns" ], "summary": "List saved, unfinished campaign drafts that can be resumed", "description": "List saved, unfinished campaign drafts that can be resumed.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/builder/drafts/{draftId}": { "get": { "operationId": "campaigns_builder_get", "tags": [ "campaigns" ], "summary": "Read signal build progress, preview people, messages and errors", "description": "Read signal build progress, preview people, messages and errors.", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "targeting": { "type": "object", "properties": { "titles": { "type": "array", "items": { "type": "string" } }, "locations": { "type": "array", "items": { "type": "string" } }, "companySizes": { "type": "array", "items": { "type": "string" } }, "industries": { "type": "array", "items": { "type": "string" } }, "excludes": { "type": "array", "items": { "type": "string" } }, "companies": { "type": "array", "items": { "type": "string" } }, "companyTypes": { "type": "array", "items": { "type": "string" } } }, "required": [ "titles", "locations", "companySizes", "industries", "excludes" ], "additionalProperties": false }, "signals": { "type": "array", "items": { "type": "string", "enum": [ "post_engagement", "keyword", "hiring", "funding", "launch", "new_leader", "voice_engagement", "company_engagement", "brand_engagement", "lookalike" ] } }, "people": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } }, "required": [ "status", "targeting", "signals", "people" ], "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "delete": { "operationId": "campaigns_builder_discard", "tags": [ "campaigns" ], "summary": "Discard a saved draft that has not become a campaign", "description": "Discard a saved draft that has not become a campaign.", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "null" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/builder/drafts/{draftId}/build": { "post": { "operationId": "campaigns_builder_build", "tags": [ "campaigns" ], "summary": "Start the same billable signal/audience/message build used by the UI; poll the draft for progress", "description": "Start the same billable signal/audience/message build used by the UI; poll the draft for progress.", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "started": { "type": "boolean" } }, "required": [ "ok", "started" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/builder/drafts/{draftId}/create": { "post": { "operationId": "campaigns_builder_create", "tags": [ "campaigns" ], "summary": "Create a campaign from a reviewed signal draft. Does not launch the campaign", "description": "Create a campaign from a reviewed signal draft. Does not launch the campaign.", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 120 }, "timezone": { "type": "string" }, "paused": { "description": "Save paused: signals wait to run until launch.", "type": "boolean" } } } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "sequenceId": { "type": "string" }, "enrolled": { "type": "number" } }, "required": [ "sequenceId", "enrolled" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/builder/drafts/{draftId}/people/{leadId}/opener": { "put": { "operationId": "campaigns_builder_opener", "tags": [ "campaigns" ], "summary": "Edit or reset one preview person's opening line before creating the campaign", "description": "Edit or reset one preview person's opening line before creating the campaign.", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "leadId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "opener": { "type": "string" } }, "required": [ "opener" ] }, "example": { "opener": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "null" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/builder/drafts/{draftId}/setup": { "get": { "operationId": "campaigns_builder_resume", "tags": [ "campaigns" ], "summary": "Read a saved draft's setup (source, name, targeting, signals, terms, lookalike) to resume it", "description": "Read a saved draft's setup (source, name, targeting, signals, terms, lookalike) to resume it.", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "clientRequestId": { "type": "string" }, "status": { "type": "string" }, "targeting": { "type": "object", "properties": { "titles": { "type": "array", "items": { "type": "string" } }, "locations": { "type": "array", "items": { "type": "string" } }, "companySizes": { "type": "array", "items": { "type": "string" } }, "industries": { "type": "array", "items": { "type": "string" } }, "excludes": { "type": "array", "items": { "type": "string" } }, "companies": { "type": "array", "items": { "type": "string" } }, "companyTypes": { "type": "array", "items": { "type": "string" } } }, "required": [ "titles", "locations", "companySizes", "industries", "excludes" ], "additionalProperties": false }, "signals": { "type": "array", "items": { "type": "string", "enum": [ "post_engagement", "keyword", "hiring", "funding", "launch", "new_leader", "voice_engagement", "company_engagement", "brand_engagement", "lookalike" ] } } }, "required": [ "clientRequestId", "status", "targeting", "signals" ], "additionalProperties": {} }, { "type": "null" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/builder/drafts/{draftId}/outreach": { "patch": { "operationId": "campaigns_builder_outreach", "tags": [ "campaigns" ], "summary": "Save a draft's Outreach and Review choices: AI or manual steps, the brief, the steps, who sends and when, and auto or manual approval", "description": "Save a draft's Outreach and Review choices: AI or manual steps, the brief, the steps, who sends and when, and auto or manual approval.", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "outreachMode": { "description": "ai: generate the sequence from the brief. manual: write steps.", "type": "string", "enum": [ "ai", "manual" ] }, "brief": { "type": "object", "properties": { "goal": { "type": "string", "description": "What a reply should lead to, e.g. a demo." }, "helpWith": { "type": "string", "description": "The problem the product solves for them." }, "tone": { "type": "string", "enum": [ "conversational", "warm", "direct", "formal" ] }, "channels": { "type": "string", "enum": [ "both", "email", "linkedin" ] } }, "required": [ "goal", "helpWith", "tone", "channels" ], "additionalProperties": false }, "steps": { "maxItems": 12, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "wait", "linkedin_connection", "linkedin_message" ] }, "waitHours": { "description": "Hours to wait, 1 to 1440. Required on a wait step.", "type": "number", "minimum": 1, "maximum": 1440 }, "emailSubject": { "type": "string", "maxLength": 200 }, "emailTextBody": { "description": "Plain text only; draft steps keep no HTML body.", "type": "string", "maxLength": 5000 }, "emailReplyToPrevious": { "type": "boolean" }, "onlyIf": { "type": "string", "enum": [ "always", "connected", "not_connected" ] }, "linkedinMessageBody": { "type": "string", "maxLength": 5000 }, "linkedinMessageMode": { "type": "string", "enum": [ "skip_if_not_connected", "wait_until_connected" ] }, "connectionTimeoutHours": { "type": "number", "minimum": 1, "maximum": 1440 } }, "required": [ "type" ], "additionalProperties": false } }, "sending": { "type": "object", "properties": { "emailMailboxAccountIds": { "type": "array", "items": { "type": "string" } }, "linkedinAccountIds": { "type": "array", "items": { "type": "string" } }, "timezone": { "type": "string" }, "startHour": { "type": "integer", "minimum": 0, "maximum": 24 }, "endHour": { "type": "integer", "minimum": 0, "maximum": 24 }, "weekdays": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 }, "description": "0 is Sunday, 6 is Saturday." }, "dailySendCap": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "emailMailboxAccountIds", "linkedinAccountIds", "timezone", "startHour", "endHour", "weekdays" ], "additionalProperties": false }, "approvalMode": { "type": "string", "enum": [ "auto", "manual" ], "description": "auto: new people a signal finds start the sequence on their own. manual: they wait for approval." } } } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "null" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/builder/drafts/{draftId}/sequence": { "post": { "operationId": "campaigns_builder_sequence", "tags": [ "campaigns" ], "summary": "Generate the draft's sequence from a brief (goal, problem, tone, channels), as Generate sequence does. AI credits apply", "description": "Generate the draft's sequence from a brief (goal, problem, tone, channels), as Generate sequence does. AI credits apply.", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "brief": { "type": "object", "properties": { "goal": { "type": "string", "description": "What a reply should lead to, e.g. a demo." }, "helpWith": { "type": "string", "description": "The problem the product solves for them." }, "tone": { "type": "string", "enum": [ "conversational", "warm", "direct", "formal" ] }, "channels": { "type": "string", "enum": [ "both", "email", "linkedin" ] } }, "required": [ "goal", "helpWith", "tone", "channels" ], "additionalProperties": false } }, "required": [ "brief" ] }, "example": { "brief": {} } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/builder/lookalike": { "post": { "operationId": "campaigns_builder_lookalike", "tags": [ "campaigns" ], "summary": "Set up a lookalike from the best lead's LinkedIn URL (role, similar roles, place, industry, similar companies), suggest roles again, or re-scope to a company. Nothing is saved. Provider credits apply", "description": "Set up a lookalike from the best lead's LinkedIn URL (role, similar roles, place, industry, similar companies), suggest roles again, or re-scope to a company. Nothing is saved. Provider credits apply.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedinUrl": { "description": "The best lead's LinkedIn profile URL.", "type": "string", "maxLength": 300 }, "suggest": { "description": "Suggest similar roles and related industries again.", "type": "object", "properties": { "title": { "type": "string" }, "industry": { "type": "string" } }, "required": [ "title" ], "additionalProperties": false }, "rescope": { "description": "Re-scope the lookalike to a different company.", "type": "object", "properties": { "seed": { "type": "object", "properties": { "name": { "type": "string" }, "linkedinUrl": { "type": "string" }, "title": { "type": "string" }, "companyName": { "type": "string" }, "companyDomain": { "type": "string" }, "avatarUrl": { "type": "string" } }, "required": [ "name", "linkedinUrl" ], "additionalProperties": false }, "company": { "type": "string" }, "title": { "type": "string" }, "location": { "type": "string" } }, "required": [ "seed", "company" ], "additionalProperties": false } } } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/builder/voices": { "post": { "operationId": "campaigns_builder_voices", "tags": [ "campaigns" ], "summary": "Suggest market voices (LinkedIn experts) for the campaign's topics, to watch with voice_engagement. AI credits apply", "description": "Suggest market voices (LinkedIn experts) for the campaign's topics, to watch with voice_engagement. AI credits apply.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "topics": { "type": "array", "items": { "type": "string" } }, "market": { "type": "string", "maxLength": 300 } } } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/builder/autofill": { "post": { "operationId": "campaigns_builder_autofill", "tags": [ "campaigns" ], "summary": "Turn an audience description into targeting filters. AI credits apply", "description": "Turn an audience description into targeting filters. AI credits apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "minLength": 3, "maxLength": 300 } }, "required": [ "description" ] }, "example": { "description": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "targeting": { "type": "object", "properties": { "titles": { "type": "array", "items": { "type": "string" } }, "locations": { "type": "array", "items": { "type": "string" } }, "companySizes": { "type": "array", "items": { "type": "string" } }, "industries": { "type": "array", "items": { "type": "string" } }, "excludes": { "type": "array", "items": { "type": "string" } }, "companies": { "type": "array", "items": { "type": "string" } }, "companyTypes": { "type": "array", "items": { "type": "string" } } }, "required": [ "titles", "locations", "companySizes", "industries", "excludes" ], "additionalProperties": false } }, "required": [ "targeting" ], "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/campaigns/builder/estimate": { "post": { "operationId": "campaigns_builder_estimate", "tags": [ "campaigns" ], "summary": "Estimate audience or weekly signal volume using the UI's cached estimator. Provider credits may apply", "description": "Estimate audience or weekly signal volume using the UI's cached estimator. Provider credits may apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "people", "week" ] }, "targeting": { "type": "object", "properties": { "titles": { "type": "array", "items": { "type": "string" } }, "locations": { "type": "array", "items": { "type": "string" } }, "companySizes": { "type": "array", "items": { "type": "string" } }, "industries": { "type": "array", "items": { "type": "string" } }, "excludes": { "type": "array", "items": { "type": "string" } }, "companies": { "type": "array", "items": { "type": "string" } }, "companyTypes": { "type": "array", "items": { "type": "string" } } }, "required": [ "titles", "locations", "companySizes", "industries", "excludes" ], "additionalProperties": false }, "signals": { "type": "array", "items": { "type": "string", "enum": [ "post_engagement", "keyword", "hiring", "funding", "launch", "new_leader", "voice_engagement", "company_engagement", "brand_engagement", "lookalike" ] } }, "signalTerms": { "type": "object", "properties": { "post_engagement": { "description": "Post topics, phrased as what the buyer does (\"using AI for outbound\"), not bare product names.", "type": "array", "items": { "type": "string" } }, "keyword": { "type": "array", "items": { "type": "string" } }, "hiring": { "description": "Roles being hired for.", "type": "array", "items": { "type": "string" } }, "voice_engagement": { "description": "LinkedIn profile URLs of market voices whose posts to watch.", "type": "array", "items": { "type": "string" } }, "company_engagement": { "description": "LinkedIn company page URLs of companies and competitors.", "type": "array", "items": { "type": "string" } }, "brand_engagement": { "description": "The sender's own LinkedIn company page URL.", "type": "array", "items": { "type": "string" } }, "exact": { "description": "Topic signals searched by their exact keywords only (no drafted phrases).", "type": "array", "items": { "type": "string", "enum": [ "post_engagement", "keyword" ] } } }, "additionalProperties": false } }, "required": [ "kind", "targeting" ] }, "example": { "kind": "people", "targeting": {} } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "count" ], "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/commands": { "get": { "operationId": "commands_list", "tags": [ "meta" ], "summary": "List operations", "description": "List all CLI/API operations and parity classifications.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "operations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "group": { "type": "string" }, "summary": { "type": "string" }, "cli": { "type": "string" }, "aliases": { "type": "array", "items": { "type": "string" } }, "method": { "type": "string" }, "path": { "type": "string" }, "backend": { "type": "string", "enum": [ "api", "gateway", "custom", "local" ] }, "deprecated": { "type": "boolean" } }, "required": [ "id", "group", "summary", "cli", "aliases", "method", "path", "backend", "deprecated" ], "additionalProperties": false } } }, "required": [ "operations" ], "additionalProperties": false }, "example": { "operations": [ { "id": "crm.entries.create", "group": "crm", "summary": "Create a CRM entry.", "cli": "dench crm entries create", "aliases": [], "method": "POST", "path": "/crm/objects/{objectName}/entries", "backend": "api", "deprecated": false } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/auth/signin-requests": { "post": { "operationId": "auth_signin_create", "tags": [ "auth" ], "summary": "Create sign-in request", "description": "Create an agent sign-in request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "codeHash": { "type": "string" }, "sessionTokenHash": { "type": "string" }, "agentName": { "type": "string" }, "agentKind": { "type": "string", "description": "Agent kind, normalized to snake_case." }, "intent": { "type": "string", "enum": [ "join_existing", "create_workspace" ], "description": "Whether to join an existing workspace or create a new one." }, "proposedOrganizationName": { "description": "Required when intent is create_workspace.", "type": "string" }, "requestedOrganizationSelector": { "type": "string" }, "userAgent": { "type": "string" } }, "required": [ "codeHash", "sessionTokenHash", "agentName", "agentKind", "intent" ] }, "example": { "codeHash": "string", "sessionTokenHash": "string", "agentName": "string", "agentKind": "string", "intent": "join_existing" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "pending" }, "expiresAt": { "type": "number", "description": "Epoch ms when the sign-in code expires." } }, "required": [ "status", "expiresAt" ], "additionalProperties": false }, "example": { "status": "pending", "expiresAt": 1765526400000 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/auth/signin-requests/{requestId}/poll": { "post": { "operationId": "auth_signin_poll", "tags": [ "auth" ], "summary": "Poll sign-in request", "description": "Poll an agent sign-in request until approval.", "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "codeHash": { "type": "string" }, "sessionTokenHash": { "type": "string" } }, "required": [ "codeHash", "sessionTokenHash" ] }, "example": { "codeHash": "string", "sessionTokenHash": "string" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "approved", "rejected", "expired" ] }, "organization": { "description": "Present once approved.", "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "agent": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" } }, "required": [ "id", "name", "kind" ], "additionalProperties": false }, "sessionExpiresAt": { "type": "number" } }, "required": [ "status" ], "additionalProperties": false }, "example": { "status": "approved", "organization": { "id": "org_abc123", "name": "Acme", "slug": "acme" }, "agent": { "id": "ag_xyz789", "name": "Cursor", "kind": "cursor" }, "sessionExpiresAt": 1773302400000 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/auth/otp/start": { "post": { "operationId": "auth_otp_start", "tags": [ "auth" ], "summary": "Start email OTP", "description": "Start the email OTP sign-in flow.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email to send the code to." } }, "required": [ "email" ] }, "example": { "email": "string" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false }, "example": { "ok": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/auth/otp/verify": { "post": { "operationId": "auth_otp_verify", "tags": [ "auth" ], "summary": "Verify email OTP", "description": "Verify an email OTP sign-in code.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "code": { "type": "string", "description": "6+ digit code from the email." }, "agentName": { "type": "string" }, "agentKind": { "type": "string" }, "sessionTokenHash": { "type": "string", "description": "sha256 hex of the local session token." }, "intent": { "type": "string", "enum": [ "join_existing", "create_workspace" ], "description": "Whether to join an existing workspace or create a new one." }, "proposedOrganizationName": { "type": "string" }, "organizationSelector": { "type": "string" }, "userAgent": { "type": "string" } }, "required": [ "email", "code", "agentName", "agentKind", "sessionTokenHash", "intent" ] }, "example": { "email": "string", "code": "string", "agentName": "string", "agentKind": "string", "sessionTokenHash": "string", "intent": "join_existing" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "result": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "completed" }, "organization": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "sessionExpiresAt": { "type": "number" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "requiresOrgChoice" }, "authToken": { "type": "string", "description": "Pass to /auth/otp/finalize with the chosen org." }, "organizations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false } }, "expiresAt": { "type": "number" } }, "required": [ "kind", "authToken", "organizations", "expiresAt" ], "additionalProperties": false } ] } }, "required": [ "ok", "result" ], "additionalProperties": false }, "example": { "ok": true, "result": { "kind": "completed", "organization": { "id": "org_abc123", "name": "Acme", "slug": "acme" }, "sessionExpiresAt": 1773302400000 } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/auth/otp/finalize": { "post": { "operationId": "auth_otp_finalize", "tags": [ "auth" ], "summary": "Finalize OTP session", "description": "Finalize an email OTP sign-in session.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "authToken": { "type": "string" }, "organizationId": { "description": "Provide this OR newOrganizationName.", "type": "string" }, "newOrganizationName": { "type": "string" } }, "required": [ "authToken" ] }, "example": { "authToken": "string" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "result": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "sessionExpiresAt": { "type": "number" } }, "additionalProperties": false } }, "required": [ "ok", "result" ], "additionalProperties": false }, "example": { "ok": true, "result": { "organization": { "id": "org_abc123", "name": "Acme", "slug": "acme" }, "sessionExpiresAt": 1773302400000 } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/local/sessions": { "get": { "operationId": "sessions_local_list", "tags": [ "local" ], "summary": "List local sessions", "description": "List local CLI sessions.", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Local-only CLI operation. CLI sessions live in the caller's ~/.dench/config.json.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "error": { "message": "CLI sessions live in the caller's ~/.dench/config.json.", "type": "invalid_request_error", "code": "local_only" } } } } }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/local/sessions/use": { "post": { "operationId": "sessions_local_use", "tags": [ "local" ], "summary": "Use local session", "description": "Select a local CLI session.", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Local-only CLI operation. The server cannot mutate the caller's local CLI config.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "error": { "message": "The server cannot mutate the caller's local CLI config.", "type": "invalid_request_error", "code": "local_only" } } } } }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/local/logout": { "post": { "operationId": "sessions_local_logout", "tags": [ "local" ], "summary": "Remove local sessions", "description": "Remove local CLI sessions.", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Local-only CLI operation. The server cannot mutate the caller's local CLI config.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "error": { "message": "The server cannot mutate the caller's local CLI config.", "type": "invalid_request_error", "code": "local_only" } } } } }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/local/backend": { "post": { "operationId": "backend_local_configure", "tags": [ "local" ], "summary": "Configure CLI backend", "description": "Configure the CLI backend target.", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "description": "Local-only CLI operation. Backend selection is local CLI state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "error": { "message": "Backend selection is local CLI state.", "type": "invalid_request_error", "code": "local_only" } } } } }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/context/sections": { "get": { "operationId": "workspace_context_sections", "tags": [ "workspace" ], "summary": "Read selected scoped workspace documents and a compact context index without writes", "description": "Read selected scoped workspace documents and a compact context index without writes.", "parameters": [ { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sections", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "identity", "organisation", "user", "memory", "rules", "tools" ] } } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/context": { "get": { "operationId": "workspace_context", "tags": [ "workspace" ], "summary": "Workspace context", "description": "Return the current Dench workspace context for the bearer.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "agent": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" } }, "required": [ "id", "name", "kind" ], "additionalProperties": false }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string" }, "scope": { "type": "string", "enum": [ "organization", "project" ] } }, "required": [ "id", "title", "body", "scope" ], "additionalProperties": false } }, "activeAgents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "lastSeenAt": { "type": "number" } }, "required": [ "id", "name", "kind" ], "additionalProperties": false } }, "pendingApprovals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "reason": { "type": "string" }, "kind": { "type": "string" }, "risk": { "type": "string", "enum": [ "low", "medium", "high" ], "description": "Risk level." }, "agentId": { "type": "string" }, "createdAt": { "type": "number" } }, "required": [ "id", "title", "reason", "risk", "createdAt" ], "additionalProperties": {} } }, "recentArtifacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "runId": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "note", "draft", "report", "task_suggestion", "patch", "other" ] }, "status": { "type": "string", "enum": [ "draft", "approved", "rejected", "applied", "archived" ] }, "content": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "runId", "title", "type", "status", "content", "createdAt", "updatedAt" ], "additionalProperties": false } }, "suggestedWork": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "runId": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "note", "draft", "report", "task_suggestion", "patch", "other" ] }, "status": { "type": "string", "enum": [ "draft", "approved", "rejected", "applied", "archived" ] }, "content": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "nextCommands": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "runId", "title", "type", "status", "content", "createdAt", "updatedAt", "nextCommands" ], "additionalProperties": false } }, "memory": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "kind": { "type": "string", "enum": [ "fact", "decision", "preference", "goal", "tool_note", "other", "convention", "project_context", "agent_lesson", "docs_knowledge", "open_goal" ], "description": "Memory classification." }, "text": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "needs_review", "archived" ] }, "updatedAt": { "type": "number" } }, "required": [ "id", "key", "kind", "text", "tags", "status", "updatedAt" ], "additionalProperties": false } }, "chatAgents": { "type": "object", "properties": { "nextCommands": { "type": "array", "items": { "type": "string" } }, "activeRuns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "goal": { "type": "string" }, "status": { "type": "string" }, "model": { "type": "string" }, "createdAt": { "type": "number" } }, "required": [ "id", "goal", "status", "model", "createdAt" ], "additionalProperties": {} } }, "templates": { "type": "array", "items": { "type": "string" } } }, "required": [ "nextCommands", "activeRuns", "templates" ], "additionalProperties": false }, "tools": { "type": "object", "properties": { "discovery": { "type": "array", "items": { "type": "string" } }, "cli": { "type": "array", "items": { "type": "string" } }, "approvalPolicy": { "type": "string" } }, "required": [ "discovery", "cli", "approvalPolicy" ], "additionalProperties": false }, "nextActions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspace", "agent", "rules", "activeAgents", "pendingApprovals", "recentArtifacts", "suggestedWork", "memory", "chatAgents", "tools", "nextActions" ], "additionalProperties": false, "description": "Workspace orientation payload shared by /context, /status, /agents, and /approvals." }, "example": { "workspace": { "id": "org_abc123", "name": "Acme", "slug": "acme" }, "agent": { "id": "ag_xyz789", "name": "Cursor", "kind": "cursor" }, "rules": [], "activeAgents": [ { "id": "ag_xyz789", "name": "Cursor", "kind": "cursor", "lastSeenAt": 1765526400000 } ], "pendingApprovals": [], "recentArtifacts": [], "suggestedWork": [], "memory": [], "chatAgents": { "nextCommands": [ "dench agent new \"Find useful work\" --follow --json" ], "activeRuns": [], "templates": [] }, "tools": { "discovery": [ "dench_list_apps", "dench_search_tools" ], "cli": [ "dench apps --json" ], "approvalPolicy": "Read-only tools can run by default." }, "nextActions": [ "Ask for a goal or start a chat agent" ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/context/instructions": { "get": { "operationId": "workspace_instructions", "tags": [ "workspace" ], "summary": "Workspace instructions", "description": "Return the current workspace's standing instructions for external agents.", "parameters": [ { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "instructions": { "type": "string", "description": "Markdown standing instructions for external agents connected to this workspace." }, "workspace": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "required": [ "instructions", "workspace" ], "additionalProperties": false }, "example": { "workspace": { "name": "Acme", "slug": "acme" }, "instructions": "# Dench Workspace Instructions\n\nWorkspace: Acme (acme)\n\n## Identity\nYou are Dench..." } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/status": { "get": { "operationId": "workspace_status", "tags": [ "workspace" ], "summary": "Workspace status", "description": "Return workspace and agent status.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "agent": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" } }, "required": [ "id", "name", "kind" ], "additionalProperties": false }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string" }, "scope": { "type": "string", "enum": [ "organization", "project" ] } }, "required": [ "id", "title", "body", "scope" ], "additionalProperties": false } }, "activeAgents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "lastSeenAt": { "type": "number" } }, "required": [ "id", "name", "kind" ], "additionalProperties": false } }, "pendingApprovals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "reason": { "type": "string" }, "kind": { "type": "string" }, "risk": { "type": "string", "enum": [ "low", "medium", "high" ], "description": "Risk level." }, "agentId": { "type": "string" }, "createdAt": { "type": "number" } }, "required": [ "id", "title", "reason", "risk", "createdAt" ], "additionalProperties": {} } }, "recentArtifacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "runId": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "note", "draft", "report", "task_suggestion", "patch", "other" ] }, "status": { "type": "string", "enum": [ "draft", "approved", "rejected", "applied", "archived" ] }, "content": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "runId", "title", "type", "status", "content", "createdAt", "updatedAt" ], "additionalProperties": false } }, "suggestedWork": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "runId": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "note", "draft", "report", "task_suggestion", "patch", "other" ] }, "status": { "type": "string", "enum": [ "draft", "approved", "rejected", "applied", "archived" ] }, "content": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "nextCommands": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "runId", "title", "type", "status", "content", "createdAt", "updatedAt", "nextCommands" ], "additionalProperties": false } }, "memory": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "kind": { "type": "string", "enum": [ "fact", "decision", "preference", "goal", "tool_note", "other", "convention", "project_context", "agent_lesson", "docs_knowledge", "open_goal" ], "description": "Memory classification." }, "text": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "needs_review", "archived" ] }, "updatedAt": { "type": "number" } }, "required": [ "id", "key", "kind", "text", "tags", "status", "updatedAt" ], "additionalProperties": false } }, "chatAgents": { "type": "object", "properties": { "nextCommands": { "type": "array", "items": { "type": "string" } }, "activeRuns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "goal": { "type": "string" }, "status": { "type": "string" }, "model": { "type": "string" }, "createdAt": { "type": "number" } }, "required": [ "id", "goal", "status", "model", "createdAt" ], "additionalProperties": {} } }, "templates": { "type": "array", "items": { "type": "string" } } }, "required": [ "nextCommands", "activeRuns", "templates" ], "additionalProperties": false }, "tools": { "type": "object", "properties": { "discovery": { "type": "array", "items": { "type": "string" } }, "cli": { "type": "array", "items": { "type": "string" } }, "approvalPolicy": { "type": "string" } }, "required": [ "discovery", "cli", "approvalPolicy" ], "additionalProperties": false }, "nextActions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspace", "agent", "rules", "activeAgents", "pendingApprovals", "recentArtifacts", "suggestedWork", "memory", "chatAgents", "tools", "nextActions" ], "additionalProperties": false, "description": "Workspace orientation payload shared by /context, /status, /agents, and /approvals." }, "example": { "workspace": { "id": "org_abc123", "name": "Acme", "slug": "acme" }, "agent": { "id": "ag_xyz789", "name": "Cursor", "kind": "cursor" }, "rules": [], "activeAgents": [ { "id": "ag_xyz789", "name": "Cursor", "kind": "cursor", "lastSeenAt": 1765526400000 } ], "pendingApprovals": [], "recentArtifacts": [], "suggestedWork": [], "memory": [], "chatAgents": { "nextCommands": [ "dench agent new \"Find useful work\" --follow --json" ], "activeRuns": [], "templates": [] }, "tools": { "discovery": [ "dench_list_apps", "dench_search_tools" ], "cli": [ "dench apps --json" ], "approvalPolicy": "Read-only tools can run by default." }, "nextActions": [ "Ask for a goal or start a chat agent" ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/agents": { "get": { "operationId": "workspace_agents", "tags": [ "workspace" ], "summary": "List agents", "description": "List agents visible in the workspace status payload.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "agent": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" } }, "required": [ "id", "name", "kind" ], "additionalProperties": false }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string" }, "scope": { "type": "string", "enum": [ "organization", "project" ] } }, "required": [ "id", "title", "body", "scope" ], "additionalProperties": false } }, "activeAgents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "lastSeenAt": { "type": "number" } }, "required": [ "id", "name", "kind" ], "additionalProperties": false } }, "pendingApprovals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "reason": { "type": "string" }, "kind": { "type": "string" }, "risk": { "type": "string", "enum": [ "low", "medium", "high" ], "description": "Risk level." }, "agentId": { "type": "string" }, "createdAt": { "type": "number" } }, "required": [ "id", "title", "reason", "risk", "createdAt" ], "additionalProperties": {} } }, "recentArtifacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "runId": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "note", "draft", "report", "task_suggestion", "patch", "other" ] }, "status": { "type": "string", "enum": [ "draft", "approved", "rejected", "applied", "archived" ] }, "content": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "runId", "title", "type", "status", "content", "createdAt", "updatedAt" ], "additionalProperties": false } }, "suggestedWork": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "runId": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "note", "draft", "report", "task_suggestion", "patch", "other" ] }, "status": { "type": "string", "enum": [ "draft", "approved", "rejected", "applied", "archived" ] }, "content": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "nextCommands": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "runId", "title", "type", "status", "content", "createdAt", "updatedAt", "nextCommands" ], "additionalProperties": false } }, "memory": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "kind": { "type": "string", "enum": [ "fact", "decision", "preference", "goal", "tool_note", "other", "convention", "project_context", "agent_lesson", "docs_knowledge", "open_goal" ], "description": "Memory classification." }, "text": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "needs_review", "archived" ] }, "updatedAt": { "type": "number" } }, "required": [ "id", "key", "kind", "text", "tags", "status", "updatedAt" ], "additionalProperties": false } }, "chatAgents": { "type": "object", "properties": { "nextCommands": { "type": "array", "items": { "type": "string" } }, "activeRuns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "goal": { "type": "string" }, "status": { "type": "string" }, "model": { "type": "string" }, "createdAt": { "type": "number" } }, "required": [ "id", "goal", "status", "model", "createdAt" ], "additionalProperties": {} } }, "templates": { "type": "array", "items": { "type": "string" } } }, "required": [ "nextCommands", "activeRuns", "templates" ], "additionalProperties": false }, "tools": { "type": "object", "properties": { "discovery": { "type": "array", "items": { "type": "string" } }, "cli": { "type": "array", "items": { "type": "string" } }, "approvalPolicy": { "type": "string" } }, "required": [ "discovery", "cli", "approvalPolicy" ], "additionalProperties": false }, "nextActions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspace", "agent", "rules", "activeAgents", "pendingApprovals", "recentArtifacts", "suggestedWork", "memory", "chatAgents", "tools", "nextActions" ], "additionalProperties": false, "description": "Workspace orientation payload shared by /context, /status, /agents, and /approvals." }, "example": { "workspace": { "id": "org_abc123", "name": "Acme", "slug": "acme" }, "agent": { "id": "ag_xyz789", "name": "Cursor", "kind": "cursor" }, "rules": [], "activeAgents": [ { "id": "ag_xyz789", "name": "Cursor", "kind": "cursor", "lastSeenAt": 1765526400000 } ], "pendingApprovals": [], "recentArtifacts": [], "suggestedWork": [], "memory": [], "chatAgents": { "nextCommands": [ "dench agent new \"Find useful work\" --follow --json" ], "activeRuns": [], "templates": [] }, "tools": { "discovery": [ "dench_list_apps", "dench_search_tools" ], "cli": [ "dench apps --json" ], "approvalPolicy": "Read-only tools can run by default." }, "nextActions": [ "Ask for a goal or start a chat agent" ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/approvals": { "get": { "operationId": "workspace_approvals_list", "tags": [ "approvals" ], "summary": "List approvals", "description": "List approval requests visible in the workspace status payload.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "agent": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" } }, "required": [ "id", "name", "kind" ], "additionalProperties": false }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string" }, "scope": { "type": "string", "enum": [ "organization", "project" ] } }, "required": [ "id", "title", "body", "scope" ], "additionalProperties": false } }, "activeAgents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "lastSeenAt": { "type": "number" } }, "required": [ "id", "name", "kind" ], "additionalProperties": false } }, "pendingApprovals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "reason": { "type": "string" }, "kind": { "type": "string" }, "risk": { "type": "string", "enum": [ "low", "medium", "high" ], "description": "Risk level." }, "agentId": { "type": "string" }, "createdAt": { "type": "number" } }, "required": [ "id", "title", "reason", "risk", "createdAt" ], "additionalProperties": {} } }, "recentArtifacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "runId": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "note", "draft", "report", "task_suggestion", "patch", "other" ] }, "status": { "type": "string", "enum": [ "draft", "approved", "rejected", "applied", "archived" ] }, "content": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "runId", "title", "type", "status", "content", "createdAt", "updatedAt" ], "additionalProperties": false } }, "suggestedWork": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "runId": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "note", "draft", "report", "task_suggestion", "patch", "other" ] }, "status": { "type": "string", "enum": [ "draft", "approved", "rejected", "applied", "archived" ] }, "content": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "nextCommands": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "runId", "title", "type", "status", "content", "createdAt", "updatedAt", "nextCommands" ], "additionalProperties": false } }, "memory": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "kind": { "type": "string", "enum": [ "fact", "decision", "preference", "goal", "tool_note", "other", "convention", "project_context", "agent_lesson", "docs_knowledge", "open_goal" ], "description": "Memory classification." }, "text": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "needs_review", "archived" ] }, "updatedAt": { "type": "number" } }, "required": [ "id", "key", "kind", "text", "tags", "status", "updatedAt" ], "additionalProperties": false } }, "chatAgents": { "type": "object", "properties": { "nextCommands": { "type": "array", "items": { "type": "string" } }, "activeRuns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "goal": { "type": "string" }, "status": { "type": "string" }, "model": { "type": "string" }, "createdAt": { "type": "number" } }, "required": [ "id", "goal", "status", "model", "createdAt" ], "additionalProperties": {} } }, "templates": { "type": "array", "items": { "type": "string" } } }, "required": [ "nextCommands", "activeRuns", "templates" ], "additionalProperties": false }, "tools": { "type": "object", "properties": { "discovery": { "type": "array", "items": { "type": "string" } }, "cli": { "type": "array", "items": { "type": "string" } }, "approvalPolicy": { "type": "string" } }, "required": [ "discovery", "cli", "approvalPolicy" ], "additionalProperties": false }, "nextActions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspace", "agent", "rules", "activeAgents", "pendingApprovals", "recentArtifacts", "suggestedWork", "memory", "chatAgents", "tools", "nextActions" ], "additionalProperties": false, "description": "Workspace orientation payload shared by /context, /status, /agents, and /approvals." }, "example": { "workspace": { "id": "org_abc123", "name": "Acme", "slug": "acme" }, "agent": { "id": "ag_xyz789", "name": "Cursor", "kind": "cursor" }, "rules": [], "activeAgents": [ { "id": "ag_xyz789", "name": "Cursor", "kind": "cursor", "lastSeenAt": 1765526400000 } ], "pendingApprovals": [], "recentArtifacts": [], "suggestedWork": [], "memory": [], "chatAgents": { "nextCommands": [ "dench agent new \"Find useful work\" --follow --json" ], "activeRuns": [], "templates": [] }, "tools": { "discovery": [ "dench_list_apps", "dench_search_tools" ], "cli": [ "dench apps --json" ], "approvalPolicy": "Read-only tools can run by default." }, "nextActions": [ "Ask for a goal or start a chat agent" ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "operationId": "approval_request", "tags": [ "approvals" ], "summary": "Request approval", "description": "Request human approval.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "What needs human approval." }, "reason": { "type": "string" }, "risk": { "type": "string", "enum": [ "low", "medium", "high" ], "description": "Risk level." } }, "required": [ "title", "risk" ] }, "example": { "title": "Deploy the new API branch?", "reason": "Production deploy changes public behavior.", "risk": "high" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "approvalId": { "type": "string" } }, "required": [ "ok", "approvalId" ], "additionalProperties": false }, "example": { "ok": true, "approvalId": "ap_mno345" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/artifacts": { "get": { "operationId": "workspace_artifacts_list", "tags": [ "workspace" ], "summary": "List artifacts", "description": "List artifacts for the authenticated workspace.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "runId": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "note", "draft", "report", "task_suggestion", "patch", "other" ] }, "status": { "type": "string", "enum": [ "draft", "approved", "rejected", "applied", "archived" ] }, "content": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "runId", "title", "type", "status", "content", "createdAt", "updatedAt" ], "additionalProperties": false } }, "example": [ { "id": "ra_def456", "runId": "rn_ghi789", "title": "Research summary", "type": "report", "status": "draft", "content": "Key findings...", "createdAt": 1765526400000, "updatedAt": 1765526400000 } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/suggested-work": { "get": { "operationId": "workspace_suggestedWork_list", "tags": [ "workspace" ], "summary": "Suggested work", "description": "List draft suggested-work artifacts.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "runId": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "note", "draft", "report", "task_suggestion", "patch", "other" ] }, "status": { "type": "string", "enum": [ "draft", "approved", "rejected", "applied", "archived" ] }, "content": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "runId", "title", "type", "status", "content", "createdAt", "updatedAt" ], "additionalProperties": false } }, "example": [ { "id": "ra_def456", "runId": "rn_ghi789", "title": "Follow up with 3 stale leads", "type": "task_suggestion", "status": "draft", "content": "These leads have not been contacted in 30 days...", "createdAt": 1765526400000, "updatedAt": 1765526400000 } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/lists": { "get": { "operationId": "lists_list", "tags": [ "lists" ], "summary": "List lists", "description": "List saved searches (find-result lists) in the workspace, newest first.", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "operationId": "lists_save", "tags": [ "lists" ], "summary": "Save list", "description": "Save find results as a named list (rows + filters become a workspace artifact).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "createdFrom": { "type": "string", "enum": [ "find_people", "find_companies", "find_jobs", "mixed", "watch_fire", "generate_image" ], "description": "Use find_people, find_companies or find_jobs for a prospect list." }, "title": { "type": "string", "minLength": 1, "description": "Name of the new list." }, "saved": { "description": "True makes the list visible in Find. Omitted saves an unlisted draft that can still be read or added to a campaign by id.", "type": "boolean" }, "filters": { "description": "Original search filters to retain with the list. Saving does not run a search." }, "people": { "description": "Complete person records from a search, including existing contact details and custom fields.", "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "companies": { "description": "Complete company records from a search.", "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "jobs": { "description": "Complete job records from a search.", "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } }, "required": [ "createdFrom", "title" ] }, "example": { "createdFrom": "find_people", "title": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "artifactId": { "type": "string" }, "filePath": { "type": "string" }, "rowCount": { "type": "number" }, "previewRows": { "type": "array", "items": {} }, "title": { "type": "string" }, "createdFrom": { "type": "string" } }, "required": [ "artifactId", "filePath", "rowCount", "previewRows", "title", "createdFrom" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/lists/{artifactId}/rows": { "get": { "operationId": "lists_rows", "tags": [ "lists" ], "summary": "Read saved rows with current enrichment results and original indices; cursor-paged, without repeating a search", "description": "Read saved rows with current enrichment results and original indices; cursor-paged, without repeating a search.", "parameters": [ { "name": "artifactId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "enrichment", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "enriched", "in_progress", "no_contacts", "failed", "not_enriched" ] } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/lists/{artifactId}/enrich": { "post": { "operationId": "lists_enrich", "tags": [ "lists" ], "summary": "Buy contact details for 1–100 saved profiles and save them to the list. Skips fields already found, looked up empty, or in flight. Requires a signed-in member or their personal agent", "description": "Buy contact details for 1–100 saved profiles and save them to the list. Skips fields already found, looked up empty, or in flight. Requires a signed-in member or their personal agent.", "parameters": [ { "name": "artifactId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "fields": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "email", "phone", "personal_email" ] }, "description": "email is work email." } }, "required": [ "rows", "fields" ] }, "example": { "rows": [], "fields": [] } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/lists/{artifactId}/import": { "post": { "operationId": "lists_import", "tags": [ "lists" ], "summary": "Explicitly import selected saved profiles, optionally filtered by enrichment, with a configured Lead status. Reuses CRM records; never sends outreach or triggers conversion", "description": "Explicitly import selected saved profiles, optionally filtered by enrichment, with a configured Lead status. Reuses CRM records; never sends outreach or triggers conversion.", "parameters": [ { "name": "artifactId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "to": { "type": "string", "enum": [ "lead", "company", "job_posting" ] }, "rowIndexes": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "status": { "type": "string", "minLength": 1 }, "enrichment": { "type": "string", "enum": [ "all", "enriched", "in_progress", "no_contacts", "failed", "not_enriched" ] }, "viewName": { "type": "string" }, "pin": { "type": "boolean" } }, "required": [ "to" ] }, "example": { "to": "lead" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/lists/{artifactId}": { "get": { "operationId": "lists_get", "tags": [ "lists" ], "summary": "Get list", "description": "Get one saved search / list by artifact id.", "parameters": [ { "name": "artifactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "patch": { "operationId": "lists_update", "tags": [ "lists" ], "summary": "Update list", "description": "Update a saved list in place (title, filters, and/or replacement rows).", "parameters": [ { "name": "artifactId", "in": "path", "required": true, "schema": { "type": "string", "description": "The existing list id." }, "description": "The existing list id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "filters": { "description": "Replacement filter metadata; does not run a new search." }, "people": { "description": "Replacement people. Omit to preserve existing rows; an empty array clears them.", "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "companies": { "description": "Replacement companies. Omit to preserve existing rows.", "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "jobs": { "description": "Replacement jobs. Omit to preserve existing rows.", "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } } } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "artifactId": { "type": "string" }, "rowCount": { "type": "number" }, "previewRows": { "type": "array", "items": {} }, "title": { "type": "string" } }, "required": [ "artifactId", "rowCount", "previewRows", "title" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "delete": { "operationId": "lists_delete", "tags": [ "lists" ], "summary": "Delete list", "description": "Delete a saved search / list, its exported CSV/JSONL files, and any linked watch.", "parameters": [ { "name": "artifactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/lists/{artifactId}/rename": { "post": { "operationId": "lists_rename", "tags": [ "lists" ], "summary": "Rename list", "description": "Rename a saved search / list.", "parameters": [ { "name": "artifactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/lists/{artifactId}/reviews": { "get": { "operationId": "lists_prospects_reviews", "tags": [ "lists" ], "summary": "Read durable enrichment activity (legacy review metadata remains readable). Use lists rows for current saved profiles and contacts", "description": "Read durable enrichment activity (legacy review metadata remains readable). Use lists rows for current saved profiles and contacts.", "parameters": [ { "name": "artifactId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/lists/{artifactId}/assess": { "post": { "operationId": "lists_prospects_assess", "tags": [ "lists" ], "summary": "Suggest ICP fit for one profile. Never changes a human review decision", "description": "Suggest ICP fit for one profile. Never changes a human review decision.", "parameters": [ { "name": "artifactId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "row": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "suggestion": { "type": "object", "properties": { "fit": { "type": "string", "enum": [ "likely_fit", "unlikely_fit", "unknown" ] }, "score": { "description": "AI relevance to the saved ICP, not conversion probability.", "type": "integer", "minimum": 0, "maximum": 100 }, "reason": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "fit", "reason" ], "additionalProperties": false } }, "required": [ "row", "suggestion" ] }, "example": { "row": {}, "suggestion": {} } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/memory/search": { "get": { "operationId": "memory_search", "tags": [ "memory" ], "summary": "Search memory", "description": "Search durable workspace memory.", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Full-text query." }, "description": "Full-text query." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 20 } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "_creationTime": { "type": "number" }, "key": { "type": "string" }, "kind": { "type": "string", "enum": [ "fact", "decision", "preference", "goal", "tool_note", "other", "convention", "project_context", "agent_lesson", "docs_knowledge", "open_goal" ], "description": "Memory classification." }, "text": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "needs_review", "archived" ] }, "source": { "type": "string" }, "visibility": { "type": "string", "enum": [ "user", "org" ], "description": "Who can see the memory. Defaults to `user`." }, "confidence": { "type": "number" }, "importance": { "type": "number" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "_id", "_creationTime", "key", "kind", "text", "tags", "status", "source", "createdAt", "updatedAt" ], "additionalProperties": {}, "description": "A workspace memory document." } }, "example": [ { "_id": "wm_jkl012", "_creationTime": 1765526400000, "key": "deployment-policy", "kind": "decision", "text": "Never deploy without human approval.", "tags": [ "deployment", "policy" ], "status": "active", "source": "agent", "createdAt": 1765526400000, "updatedAt": 1765526400000 } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/memory": { "post": { "operationId": "memory_save", "tags": [ "memory" ], "summary": "Save memory", "description": "Save a durable workspace memory fact.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "description": "Stable memory key." }, "kind": { "type": "string", "enum": [ "fact", "decision", "preference", "goal", "tool_note", "other", "convention", "project_context", "agent_lesson", "docs_knowledge", "open_goal" ], "description": "Memory classification." }, "text": { "type": "string", "description": "Memory body. No secrets or scratch notes." }, "tags": { "type": "array", "items": { "type": "string" } }, "sensitivity": { "type": "string", "enum": [ "normal", "broad", "sensitive" ], "description": "Sensitivity tier; `sensitive` memories land in needs-review." }, "visibility": { "type": "string", "enum": [ "user", "org" ], "description": "Who can see the memory. Defaults to `user`." }, "projectId": { "type": "string" }, "sourceQuote": { "type": "string" }, "confidence": { "type": "number" }, "importance": { "type": "number" } }, "required": [ "key", "kind", "text" ] }, "example": { "key": "deployment-policy", "kind": "decision", "text": "Never deploy without human approval.", "tags": [ "deployment", "policy" ] } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "memoryId": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "needs_review", "archived" ] } }, "required": [ "ok", "memoryId", "status" ], "additionalProperties": false }, "example": { "ok": true, "memoryId": "wm_jkl012", "status": "active" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/approvals/{approvalId}/decision": { "post": { "operationId": "approval_decide", "tags": [ "approvals" ], "summary": "Decide approval", "description": "Record an approval decision.", "parameters": [ { "name": "approvalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "decision": { "type": "string", "enum": [ "approved", "rejected" ], "description": "Human decision for an approval request." }, "evidence": { "description": "Required when the requesting agent records its own decision.", "type": "string" } }, "required": [ "decision" ] }, "example": { "decision": "approved", "evidence": "User said yes in chat" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "status": { "type": "string", "enum": [ "approved", "rejected" ], "description": "Human decision for an approval request." } }, "required": [ "ok", "status" ], "additionalProperties": false }, { "type": "object", "properties": { "ok": { "type": "boolean", "const": false }, "code": { "type": "string", "description": "e.g. approval_not_pending." }, "error": { "type": "string" } }, "required": [ "ok", "code", "error" ], "additionalProperties": false } ] }, "example": { "ok": true, "status": "approved" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/billing/status": { "get": { "operationId": "billing_status", "tags": [ "billing" ], "summary": "Billing status", "description": "Get billing and AI credit status.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "availableCreditsCents": { "type": "number" }, "creditConsumedCents": { "type": "number" }, "billedCents": { "type": "number" }, "onDemandSpendCents": { "type": "number" }, "monthlySpendLimitCents": { "type": "number" }, "spendLimitRemainingCents": { "type": "number" }, "subscriptionStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeCustomerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "grants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "source": { "type": "string", "enum": [ "starter", "trial", "monthly", "topup", "manual", "referral" ] }, "category": { "type": "string", "enum": [ "promotional", "paid" ] }, "status": { "type": "string", "enum": [ "pending", "granted", "depleted", "expired", "voided" ] }, "amountCents": { "type": "number" }, "usedCents": { "type": "number" }, "remainingCents": { "type": "number" }, "effectiveAt": { "type": "number" }, "expiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "source", "category", "status", "amountCents", "usedCents", "remainingCents", "effectiveAt", "expiresAt" ], "additionalProperties": false } }, "nextCommands": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspace", "availableCreditsCents", "creditConsumedCents", "billedCents", "onDemandSpendCents", "monthlySpendLimitCents", "spendLimitRemainingCents", "subscriptionStatus", "stripeCustomerId", "grants", "nextCommands" ], "additionalProperties": {} }, "example": { "workspace": { "id": "org_abc123", "name": "Acme", "slug": "acme" }, "availableCreditsCents": 500, "creditConsumedCents": 120, "billedCents": 120, "onDemandSpendCents": 0, "monthlySpendLimitCents": 5000, "spendLimitRemainingCents": 4880, "subscriptionStatus": "active", "stripeCustomerId": "cus_abc123", "grants": [ { "id": "gr_pqr678", "source": "starter", "category": "promotional", "status": "granted", "amountCents": 500, "usedCents": 120, "remainingCents": 380, "effectiveAt": 1765526400000, "expiresAt": null } ], "nextCommands": [ "dench billing topup --amount 20" ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/billing/topup": { "post": { "operationId": "billing_topup", "tags": [ "billing" ], "summary": "Top up credits", "description": "Create an AI credit top-up checkout link.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "description": "Idempotency key (1-200 of [A-Za-z0-9:_-])." }, "amountUsd": { "type": "number", "description": "USD amount, $5 to $1000." } }, "required": [ "requestId", "amountUsd" ] }, "example": { "requestId": "string", "amountUsd": 0 } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "charged": { "type": "boolean", "const": true }, "amountCents": { "type": "number" } }, "required": [ "charged", "amountCents" ], "additionalProperties": false, "description": "Saved card charged directly." }, { "type": "object", "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url" ], "additionalProperties": false, "description": "Stripe Checkout link to complete the top-up." } ] }, "example": { "url": "https://checkout.stripe.com/c/pay/cs_test_abc123" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/billing/upgrade": { "post": { "operationId": "billing_upgrade", "tags": [ "billing" ], "summary": "Upgrade workspace", "description": "Create a workspace upgrade checkout link.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "tier": { "type": "string", "enum": [ "pro", "max", "cloud", "desktop", "api" ] }, "billingCycle": { "type": "string", "enum": [ "monthly", "yearly" ] }, "requestId": { "type": "string" }, "returnPath": { "description": "Internal return path beginning with /.", "type": "string" } } } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "updated": { "type": "boolean", "const": true }, "tier": { "type": "string" }, "billingCycle": { "type": "string" }, "stripeSubscriptionId": { "type": "string" } }, "required": [ "updated", "tier", "stripeSubscriptionId" ], "additionalProperties": false, "description": "Existing subscription updated in place." }, { "type": "object", "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url" ], "additionalProperties": false, "description": "Stripe Checkout link to complete the upgrade." } ] }, "example": { "url": "https://checkout.stripe.com/c/pay/cs_test_xyz789" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/chat/threads": { "get": { "operationId": "chat_list", "tags": [ "chat" ], "summary": "List threads", "description": "List past chat threads.", "parameters": [ { "name": "titleQuery", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "includeArchived", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "includeAutomated", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "threadId": { "type": "string" }, "title": { "type": "string" }, "lastMessageAt": { "type": "number" }, "createdAt": { "type": "number" }, "status": { "type": "string", "enum": [ "idle", "streaming", "error" ] }, "visibility": { "type": "string", "enum": [ "private", "shared" ] }, "createdByUserId": { "type": "string" }, "archivedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "fileContextPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "parentThreadId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent thread when this is a spawned sub-agent." }, "nestingDepth": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "activeRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "threadId", "title", "lastMessageAt", "createdAt", "status", "visibility", "createdByUserId", "archivedAt", "fileContextPath", "parentThreadId", "nestingDepth", "summary", "activeRunId" ], "additionalProperties": false } }, "example": [ { "threadId": "th_abc123", "title": "Deploy checklist", "lastMessageAt": 1765526400000, "createdAt": 1765526000000, "status": "idle", "visibility": "private", "createdByUserId": "us_xyz789", "archivedAt": null, "fileContextPath": null, "parentThreadId": null, "nestingDepth": null, "summary": null, "activeRunId": null } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "patch": { "operationId": "chat_rename", "tags": [ "chat" ], "summary": "Rename threads", "description": "Rename one or more chat threads.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "threadId": { "type": "string" }, "title": { "type": "string" } }, "required": [ "threadId", "title" ], "additionalProperties": false } } }, "required": [ "items" ] }, "example": { "items": [ { "threadId": "th_abc123", "title": "Deploy checklist" } ] } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "threadId": { "type": "string" }, "ok": { "type": "boolean" }, "error": { "type": "string" } }, "required": [ "threadId", "ok" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" } }, "required": [ "results", "succeeded", "failed" ], "additionalProperties": false }, "example": { "results": [ { "threadId": "th_abc123", "ok": true } ], "succeeded": 1, "failed": 0 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "delete": { "operationId": "chat_delete", "tags": [ "chat" ], "summary": "Delete threads", "description": "Delete one or more chat threads.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "threadIds": { "minItems": 1, "maxItems": 25, "type": "array", "items": { "type": "string" } }, "includeAutomated": { "type": "boolean" } }, "required": [ "threadIds" ] }, "example": { "threadIds": [ "th_abc123" ] } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "scheduled": { "type": "number" }, "rejected": { "type": "array", "items": { "type": "object", "properties": { "threadId": { "type": "string" }, "reason": { "type": "string", "description": "e.g. automated_thread_protected." }, "message": { "type": "string" } }, "required": [ "threadId", "reason" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "scheduled", "rejected", "total" ], "additionalProperties": false }, "example": { "scheduled": 2, "rejected": [], "total": 2 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "operationId": "chat_new", "tags": [ "chat" ], "summary": "New chat", "description": "Start a new chat-turn workflow.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "environment": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,63}$" }, "prompt": { "type": "string", "description": "The user message that starts the turn." }, "model": { "type": "string" }, "fileContextPath": { "type": "string" }, "visibility": { "type": "string", "enum": [ "private", "shared" ] }, "yolo": { "description": "Bypass approval gates for this turn.", "type": "boolean" }, "title": { "type": "string" } }, "required": [ "prompt" ] }, "example": { "prompt": "Summarize the latest CRM changes." } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "threadId": { "type": "string" }, "runId": { "type": "string" }, "workflowRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "threadUrl": { "type": "string", "description": "Web URL of the thread." }, "streamUrl": { "type": "string", "description": "SSE stream URL for the live response." }, "yolo": { "type": "boolean" } }, "required": [ "threadId", "runId", "workflowRunId", "threadUrl", "streamUrl", "yolo" ], "additionalProperties": false }, "example": { "threadId": "th_abc123", "runId": "rn_def456", "workflowRunId": "wrun_01HX9", "threadUrl": "https://www.dench.com/acme/chat/th_abc123", "streamUrl": "https://www.dench.com/api/chat/stream?sessionId=th_abc123", "yolo": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/chat/search": { "get": { "operationId": "chat_search", "tags": [ "chat" ], "summary": "Search chats", "description": "Search past chat messages.", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Full-text query across past messages." }, "description": "Full-text query across past messages." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "excludeThreadId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "includeAutomated", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "threadId": { "type": "string" }, "threadTitle": { "type": "string" }, "messageId": { "type": "string" }, "role": { "type": "string", "enum": [ "user", "assistant", "system" ] }, "snippet": { "type": "string" }, "createdAt": { "type": "number" }, "runId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "threadId", "threadTitle", "messageId", "role", "snippet", "createdAt", "runId" ], "additionalProperties": false } }, "example": [ { "threadId": "th_abc123", "threadTitle": "Deploy checklist", "messageId": "cm_def456", "role": "user", "snippet": "How do we deploy to prod?", "createdAt": 1765526400000, "runId": null } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/chat/threads/{threadId}": { "get": { "operationId": "chat_read", "tags": [ "chat" ], "summary": "Read thread", "description": "Read a past chat thread.", "parameters": [ { "name": "threadId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "visibleTextOnly", "in": "query", "required": false, "schema": { "description": "Message text as a person sees it: text parts only, without reasoning or tool calls.", "type": "boolean" }, "description": "Message text as a person sees it: text parts only, without reasoning or tool calls." } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "thread": { "type": "object", "properties": { "threadId": { "type": "string" }, "title": { "type": "string" }, "lastMessageAt": { "type": "number" }, "createdAt": { "type": "number" }, "status": { "type": "string", "enum": [ "idle", "streaming", "error" ] }, "visibility": { "type": "string", "enum": [ "private", "shared" ] }, "createdByUserId": { "type": "string" }, "archivedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "fileContextPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "parentThreadId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent thread when this is a spawned sub-agent." }, "nestingDepth": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "activeRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "threadId", "title", "lastMessageAt", "createdAt", "status", "visibility", "createdByUserId", "archivedAt", "fileContextPath", "parentThreadId", "nestingDepth", "summary", "activeRunId" ], "additionalProperties": false }, "messages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "user", "assistant", "system" ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "text": { "type": "string" }, "runId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "enum": [ "streaming", "complete", "error", "canceled" ] }, { "type": "null" } ] }, "revision": { "type": "number" }, "isDraft": { "type": "boolean" } }, "required": [ "id", "role", "createdAt", "updatedAt", "text", "runId", "status", "revision", "isDraft" ], "additionalProperties": false } } }, "required": [ "thread", "messages" ], "additionalProperties": false }, "example": { "thread": { "threadId": "th_abc123", "title": "Deploy checklist", "lastMessageAt": 1765526400000, "createdAt": 1765526000000, "status": "idle", "visibility": "private", "createdByUserId": "us_xyz789", "archivedAt": null, "fileContextPath": null, "parentThreadId": null, "nestingDepth": null, "summary": null, "activeRunId": null }, "messages": [ { "id": "cm_def456", "role": "user", "createdAt": 1765526400000, "updatedAt": 1765526400000, "text": "How do we deploy?", "runId": null, "status": "complete", "revision": 0, "isDraft": false }, { "id": "cm_ghi789", "role": "assistant", "createdAt": 1765526460000, "updatedAt": 1765526460000, "text": "Push to main; Vercel auto-deploys.", "runId": "rn_jkl012", "status": "complete", "revision": 1, "isDraft": false } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/chat/tree": { "get": { "operationId": "chat_tree", "tags": [ "chat" ], "summary": "Thread tree", "description": "Read the parent-child chat thread hierarchy.", "parameters": [ { "name": "titleQuery", "in": "query", "required": false, "schema": { "description": "Filter threads by title.", "type": "string" }, "description": "Filter threads by title." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "includeArchived", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "includeAutomated", "in": "query", "required": false, "schema": { "description": "Include routine-spawned threads. Defaults false.", "type": "boolean" }, "description": "Include routine-spawned threads. Defaults false." } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "threadId": { "type": "string" }, "title": { "type": "string" }, "lastMessageAt": { "type": "number" }, "createdAt": { "type": "number" }, "status": { "type": "string", "enum": [ "idle", "streaming", "error" ] }, "visibility": { "type": "string", "enum": [ "private", "shared" ] }, "createdByUserId": { "type": "string" }, "archivedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "fileContextPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "parentThreadId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent thread when this is a spawned sub-agent." }, "nestingDepth": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "activeRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "threadId", "title", "lastMessageAt", "createdAt", "status", "visibility", "createdByUserId", "archivedAt", "fileContextPath", "parentThreadId", "nestingDepth", "summary", "activeRunId" ], "additionalProperties": false }, "description": "Flat thread rows; parentThreadId encodes the hierarchy." }, "example": [ { "threadId": "th_abc123", "title": "Deploy checklist", "lastMessageAt": 1765526400000, "createdAt": 1765526000000, "status": "idle", "visibility": "private", "createdByUserId": "us_xyz789", "archivedAt": null, "fileContextPath": null, "parentThreadId": null, "nestingDepth": null, "summary": null, "activeRunId": null } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/chat/threads/{threadId}/messages": { "post": { "operationId": "chat_send", "tags": [ "chat" ], "summary": "Send message", "description": "Send a message to an existing chat thread.", "parameters": [ { "name": "threadId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "prompt": { "type": "string", "description": "The message to append." }, "model": { "type": "string" }, "yolo": { "type": "boolean" } }, "required": [ "prompt" ] }, "example": { "prompt": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "threadId": { "type": "string" }, "runId": { "type": "string" }, "workflowRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "threadUrl": { "type": "string", "description": "Web URL of the thread." }, "streamUrl": { "type": "string", "description": "SSE stream URL for the live response." }, "yolo": { "type": "boolean" } }, "required": [ "threadId", "runId", "workflowRunId", "threadUrl", "streamUrl", "yolo" ], "additionalProperties": false }, "example": { "threadId": "th_abc123", "runId": "rn_ghi789", "workflowRunId": "wrun_01HXA", "threadUrl": "https://www.dench.com/acme/chat/th_abc123", "streamUrl": "https://www.dench.com/api/chat/stream?sessionId=th_abc123", "yolo": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/chat/threads/{threadId}/stream": { "get": { "operationId": "chat_follow", "tags": [ "chat" ], "summary": "Follow stream", "description": "Follow a live chat response stream.", "parameters": [ { "name": "threadId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Server-Sent Events stream of chat turn updates. Each `data:` line carries a JSON payload; the stream closes when the turn completes.", "content": { "text/event-stream": { "schema": { "type": "string", "description": "SSE frames (`data: \\n\\n`) until the turn finishes." }, "example": "data: {\"type\":\"start\",\"messageId\":\"msg_01\"}\n\ndata: {\"type\":\"text-delta\",\"id\":\"t1\",\"delta\":\"Hello\"}\n\ndata: {\"type\":\"finish\"}\n\n" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects": { "get": { "operationId": "crm_objects_list", "tags": [ "crm" ], "summary": "List objects", "description": "List CRM objects.", "parameters": [ { "name": "withReferences", "in": "query", "required": false, "schema": { "description": "Include bounded navigation references. Array reads return {data, references, referenceCoverage}; existing result envelopes keep their fields.", "type": "boolean" }, "description": "Include bounded navigation references. Array reads return {data, references, referenceCoverage}; existing result envelopes keep their fields." } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "_creationTime": { "type": "number" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "defaultView": { "type": "string", "enum": [ "table", "kanban", "calendar", "timeline", "gallery", "list" ], "description": "Default view rendered for the object." }, "sortOrder": { "type": "number" }, "immutable": { "type": "boolean" }, "visibility": { "type": "string", "enum": [ "workspace", "owner_only", "owner_plus_members" ], "description": "Who can read the object's records. Always reported as the value the object behaves as: `meeting` defaults to owner_plus_members, `calendar_event` to owner_only, anything else to workspace." }, "icon": { "type": "string" }, "viewSettings": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "savedViews": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "entryCount": { "type": "number" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "_id", "_creationTime", "organizationId", "name", "defaultView", "sortOrder", "immutable", "createdAt", "updatedAt" ], "additionalProperties": {}, "description": "A CRM object (table) document." } }, { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "_creationTime": { "type": "number" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "defaultView": { "type": "string", "enum": [ "table", "kanban", "calendar", "timeline", "gallery", "list" ], "description": "Default view rendered for the object." }, "sortOrder": { "type": "number" }, "immutable": { "type": "boolean" }, "visibility": { "type": "string", "enum": [ "workspace", "owner_only", "owner_plus_members" ], "description": "Who can read the object's records. Always reported as the value the object behaves as: `meeting` defaults to owner_plus_members, `calendar_event` to owner_only, anything else to workspace." }, "icon": { "type": "string" }, "viewSettings": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "savedViews": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "entryCount": { "type": "number" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "_id", "_creationTime", "organizationId", "name", "defaultView", "sortOrder", "immutable", "createdAt", "updatedAt" ], "additionalProperties": {}, "description": "A CRM object (table) document." } }, "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false } }, "required": [ "data", "references", "referenceCoverage" ], "additionalProperties": false } ] }, "example": [ { "_id": "obj_lead01", "_creationTime": 1765526400000, "organizationId": "org_abc123", "name": "lead", "description": "Sales leads", "defaultView": "kanban", "sortOrder": 100, "immutable": false, "icon": "target", "entryCount": 42, "createdAt": 1765526400000, "updatedAt": 1765612800000 } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "operationId": "crm_objects_create", "tags": [ "crm" ], "summary": "Create object", "description": "Create a CRM object.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Object name (lowercased, singular)." }, "description": { "type": "string" }, "defaultView": { "type": "string", "enum": [ "table", "kanban", "calendar", "timeline", "gallery", "list" ], "description": "Default view rendered for the object." }, "icon": { "description": "Hugeicons (or legacy Lucide) icon name, e.g. user-multiple, target-01.", "type": "string" }, "fields": { "description": "Fields to add after the built-in Notes, in column order. The object and its fields are created in one transaction: if any field is rejected, nothing is created.", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "description": "Defaults to text.", "type": "string", "enum": [ "text", "email", "phone", "url", "number", "boolean", "date", "richtext", "file", "user", "enum", "relation", "tags", "action" ] }, "required": { "type": "boolean" }, "defaultValue": { "type": "string" }, "relatedObjectName": { "description": "Target object for `relation` fields.", "type": "string" }, "relationshipType": { "type": "string", "enum": [ "many_to_one", "many_to_many" ], "description": "Relation cardinality for a `relation` field." }, "enumValues": { "description": "Options for `enum` fields.", "type": "array", "items": { "type": "string" } }, "enumColors": { "description": "Hex colors aligned to enumValues.", "type": "array", "items": { "type": "string" } }, "enumMultiple": { "description": "Allow multi-select enum.", "type": "boolean" }, "description": { "type": "string" }, "indexed": { "description": "Index for filter/search/sort.", "type": "boolean" } }, "required": [ "name" ], "additionalProperties": false } } }, "required": [ "name" ] }, "example": { "name": "lead", "description": "Sales leads", "defaultView": "kanban", "icon": "target" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "fields": { "description": "The fields created from `fields`, in order.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false } }, "required": [ "id" ], "additionalProperties": false }, "example": { "id": "obj_lead01" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/catalog/objects": { "get": { "operationId": "crm_objects_listCompact", "tags": [ "crm" ], "summary": "List names, display labels, visibility and workspace counts without internal state", "description": "List names, display labels, visibility and workspace counts without internal state.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "description": { "type": "string" }, "entryCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "countScope": { "type": "string", "enum": [ "workspace", "private_unknown" ] }, "visibility": { "type": "string", "enum": [ "workspace", "owner_only", "owner_plus_members" ] }, "archived": { "type": "boolean" } }, "required": [ "_id", "name", "displayName", "entryCount", "countScope", "visibility", "archived" ], "additionalProperties": false } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{name}": { "get": { "operationId": "crm_objects_get", "tags": [ "crm" ], "summary": "Get object", "description": "Get a CRM object.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_id": { "type": "string" }, "_creationTime": { "type": "number" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "defaultView": { "type": "string", "enum": [ "table", "kanban", "calendar", "timeline", "gallery", "list" ], "description": "Default view rendered for the object." }, "sortOrder": { "type": "number" }, "immutable": { "type": "boolean" }, "visibility": { "type": "string", "enum": [ "workspace", "owner_only", "owner_plus_members" ], "description": "Who can read the object's records. Always reported as the value the object behaves as: `meeting` defaults to owner_plus_members, `calendar_event` to owner_only, anything else to workspace." }, "icon": { "type": "string" }, "viewSettings": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "savedViews": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "entryCount": { "type": "number" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false } }, "required": [ "_id", "_creationTime", "organizationId", "name", "defaultView", "sortOrder", "immutable", "createdAt", "updatedAt" ], "additionalProperties": {} }, { "type": "null" } ] }, "example": { "_id": "obj_lead01", "_creationTime": 1765526400000, "organizationId": "org_abc123", "name": "lead", "description": "Sales leads", "defaultView": "kanban", "sortOrder": 100, "immutable": false, "icon": "target", "entryCount": 42, "createdAt": 1765526400000, "updatedAt": 1765612800000 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "patch": { "operationId": "crm_objects_update", "tags": [ "crm" ], "summary": "Update object", "description": "Update a CRM object.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string" }, "defaultView": { "type": "string", "enum": [ "table", "kanban", "calendar", "timeline", "gallery", "list" ], "description": "Default view rendered for the object." }, "icon": { "type": "string" }, "viewSettings": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "savedViews": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "visibility": { "description": "Who can see the object's records: every workspace member, only the record's owner, or the owner plus the members listed on the record. Admins only (a signed-in admin; an org-scoped key cannot change it). Records created before the switch have no owner and are hidden from everyone until one is set; switch back to workspace to see them again.", "type": "string", "enum": [ "workspace", "owner_only", "owner_plus_members" ] } } } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false }, "example": { "ok": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "delete": { "operationId": "crm_objects_delete", "tags": [ "crm" ], "summary": "Delete object", "description": "Delete a CRM object.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false }, "example": { "ok": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{from}/rename": { "post": { "operationId": "crm_objects_rename", "tags": [ "crm" ], "summary": "Rename object", "description": "Rename a CRM object.", "parameters": [ { "name": "from", "in": "path", "required": true, "schema": { "type": "string", "description": "Current object name (path)." }, "description": "Current object name (path)." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "to": { "type": "string", "description": "New object name." } }, "required": [ "to" ] }, "example": { "to": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false }, "example": { "ok": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{name}/archive": { "post": { "operationId": "crm_objects_archive", "tags": [ "crm" ], "summary": "Hide a CRM object's workspace sidebar row for the whole workspace. Not a delete — the table keeps working. Admin-only", "description": "Hide a CRM object's workspace sidebar row for the whole workspace. Not a delete — the table keeps working. Admin-only.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{name}/unarchive": { "post": { "operationId": "crm_objects_unarchive", "tags": [ "crm" ], "summary": "Restore a CRM object's workspace sidebar row. Admin-only", "description": "Restore a CRM object's workspace sidebar row. Admin-only.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/views": { "get": { "operationId": "crm_views_list", "tags": [ "crm" ], "summary": "List the saved views on a CRM object (plus the active view)", "description": "List the saved views on a CRM object (plus the active view).", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "objectName": { "type": "string" }, "activeView": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "views": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } }, "required": [ "objectName", "activeView", "views" ], "additionalProperties": false }, "example": { "objectName": "lead", "activeView": "Hot leads", "views": [ { "name": "Hot leads", "view_type": "table", "filters": { "id": "g1", "conjunction": "and", "rules": [ { "id": "r1", "field": "Status", "operator": "is", "value": "Hot" } ] }, "sort": [ { "field": "created_at", "direction": "desc" } ] } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "operationId": "crm_views_create", "tags": [ "crm" ], "summary": "Create a saved view (named filters/sort/columns combo) on a CRM object", "description": "Create a saved view (named filters/sort/columns combo) on a CRM object.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100, "description": "View name (upsert key; shows in the view dropdown)." }, "view_type": { "type": "string", "enum": [ "table", "kanban", "calendar", "timeline", "gallery", "list" ], "description": "Default view rendered for the object." }, "filters": { "description": "FilterGroup, e.g. {\"id\":\"g1\",\"conjunction\":\"and\",\"rules\":[{\"id\":\"r1\",\"field\":\"Status\",\"operator\":\"is\",\"value\":\"Hot\"}]}. Date rules support operator \"date_preset\" with value \"today\", \"yesterday\", \"this_week\", \"last_week\", \"this_month\", \"last_month\", \"this_quarter\", \"last_quarter\", \"this_year\", or \"last_year\", plus \"relative_past\"/\"relative_next\" with relativeAmount + relativeUnit (days|weeks|months|quarters|years). Rules may target the system timestamps \"created_at\" / \"updated_at\", e.g. {\"field\":\"created_at\",\"operator\":\"relative_past\",\"relativeAmount\":7,\"relativeUnit\":\"days\"}.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "sort": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Field name to sort by." }, "direction": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field", "direction" ], "additionalProperties": false } }, "columns": { "description": "Visible-column ordering. Omit to keep the default set.", "type": "array", "items": { "type": "string" } }, "settings": { "description": "View-type settings (kanbanField, calendarDateField, timelineStartField, …).", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "pinnedEntryIds": { "description": "Pinned-list mode: show EXACTLY these entry ids (mutually exclusive with filters).", "type": "array", "items": { "type": "string" } } }, "required": [ "name" ], "additionalProperties": {} }, "replaceExisting": { "description": "Overwrite an existing view with the same name.", "type": "boolean" }, "setActive": { "description": "Also switch the object's active view to this one.", "type": "boolean" } }, "required": [ "view" ] }, "example": { "view": { "name": "Hot leads", "view_type": "table", "filters": { "id": "g1", "conjunction": "and", "rules": [ { "id": "r1", "field": "Status", "operator": "is", "value": "Hot" } ] }, "sort": [ { "field": "created_at", "direction": "desc" } ] }, "setActive": true } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "objectName": { "type": "string" }, "viewName": { "type": "string" }, "replaced": { "type": "boolean" }, "activeView": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "ok", "objectName", "viewName", "replaced", "activeView" ], "additionalProperties": false }, "example": { "ok": true, "objectName": "lead", "viewName": "Hot leads", "replaced": false, "activeView": "Hot leads" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/views/{viewName}": { "get": { "operationId": "crm_views_get", "tags": [ "crm" ], "summary": "Get one saved view's definition by name", "description": "Get one saved view's definition by name.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "viewName", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "patch": { "operationId": "crm_views_update", "tags": [ "crm" ], "summary": "Replace a saved view's definition (upsert by name)", "description": "Replace a saved view's definition (upsert by name).", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "viewName", "in": "path", "required": true, "schema": { "type": "string", "description": "Name of the view to replace (path)." }, "description": "Name of the view to replace (path)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "description": "Full replacement definition; the path viewName is used as the name.", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100, "description": "View name (upsert key; shows in the view dropdown)." }, "view_type": { "type": "string", "enum": [ "table", "kanban", "calendar", "timeline", "gallery", "list" ], "description": "Default view rendered for the object." }, "filters": { "description": "FilterGroup, e.g. {\"id\":\"g1\",\"conjunction\":\"and\",\"rules\":[{\"id\":\"r1\",\"field\":\"Status\",\"operator\":\"is\",\"value\":\"Hot\"}]}. Date rules support operator \"date_preset\" with value \"today\", \"yesterday\", \"this_week\", \"last_week\", \"this_month\", \"last_month\", \"this_quarter\", \"last_quarter\", \"this_year\", or \"last_year\", plus \"relative_past\"/\"relative_next\" with relativeAmount + relativeUnit (days|weeks|months|quarters|years). Rules may target the system timestamps \"created_at\" / \"updated_at\", e.g. {\"field\":\"created_at\",\"operator\":\"relative_past\",\"relativeAmount\":7,\"relativeUnit\":\"days\"}.", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "sort": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Field name to sort by." }, "direction": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field", "direction" ], "additionalProperties": false } }, "columns": { "description": "Visible-column ordering. Omit to keep the default set.", "type": "array", "items": { "type": "string" } }, "settings": { "description": "View-type settings (kanbanField, calendarDateField, timelineStartField, …).", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "pinnedEntryIds": { "description": "Pinned-list mode: show EXACTLY these entry ids (mutually exclusive with filters).", "type": "array", "items": { "type": "string" } } }, "additionalProperties": {} }, "setActive": { "type": "boolean" } } }, "example": { "view": { "sort": [ { "field": "Score", "direction": "desc" } ], "columns": [ "Name", "Email", "Status", "Score" ] } } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "objectName": { "type": "string" }, "viewName": { "type": "string" }, "replaced": { "type": "boolean" }, "activeView": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "ok", "objectName", "viewName", "replaced", "activeView" ], "additionalProperties": false }, "example": { "ok": true, "objectName": "lead", "viewName": "Hot leads", "replaced": true, "activeView": null } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "delete": { "operationId": "crm_views_delete", "tags": [ "crm" ], "summary": "Delete a saved view by name (idempotent)", "description": "Delete a saved view by name (idempotent).", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "viewName", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "objectName": { "type": "string" }, "viewName": { "type": "string" }, "removed": { "type": "boolean" } }, "required": [ "ok", "objectName", "viewName", "removed" ], "additionalProperties": false }, "example": { "ok": true, "objectName": "lead", "viewName": "Hot leads", "removed": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/views/{viewName}/entries": { "get": { "operationId": "crm_views_entries", "tags": [ "crm" ], "summary": "Materialize a saved view's rows (applies its filters/sort/pins), paginated", "description": "Materialize a saved view's rows (applies its filters/sort/pins), paginated.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "viewName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, { "name": "assignedTo", "in": "query", "required": false, "schema": { "description": "Personal scope: \"me\" (the signed-in member / the human behind an agent session), \"unassigned\", or a member userId or email. Adds one has_any / is_empty rule on the object's assignee user field; rows, totalCount, sums and analytics all follow it. Never saved onto the view.", "type": "string" }, "description": "Personal scope: \"me\" (the signed-in member / the human behind an agent session), \"unassigned\", or a member userId or email. Adds one has_any / is_empty rule on the object's assignee user field; rows, totalCount, sums and analytics all follow it. Never saved onto the view." }, { "name": "assigneeField", "in": "query", "required": false, "schema": { "description": "Which `user` field \"assigned\" means. Default: the analytics owner role, else the task `Assignee`, else a user field named like owner/assignee, else the first user field.", "type": "string" }, "description": "Which `user` field \"assigned\" means. Default: the analytics owner role, else the task `Assignee`, else a user field named like owner/assignee, else the first user field." } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "description": "Materialized rows: id, entry_id, created_at, updated_at plus one key per field." }, "totalCount": { "type": "number" }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "truncated": { "type": "boolean", "description": "True when the read hit a server budget and rows may be missing." }, "assigneeScope": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "description": "The user field the scope keyed on." }, "target": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "user" }, "userId": { "type": "string" } }, "required": [ "kind", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "unassigned" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "field", "target" ], "additionalProperties": false }, { "type": "null" } ], "description": "The personal assignee scope that was applied, or null." } }, "required": [ "entries", "totalCount", "page", "pageSize", "truncated", "assigneeScope" ], "additionalProperties": {}, "description": "The same payload the workspace table renders from (fields, statuses, savedViews, …)." } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/views/{viewName}/rename": { "post": { "operationId": "crm_views_rename", "tags": [ "crm" ], "summary": "Rename view", "description": "Rename a saved view in place — keeps its filters, pins, and sidebar slot.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "viewName", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/views/{viewName}/archive": { "post": { "operationId": "crm_views_archive", "tags": [ "crm" ], "summary": "Move a pinned view's sidebar row into the Archived flyout. Admin-only", "description": "Move a pinned view's sidebar row into the Archived flyout. Admin-only.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "viewName", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/views/{viewName}/unarchive": { "post": { "operationId": "crm_views_unarchive", "tags": [ "crm" ], "summary": "Restore a view's sidebar row (re-asserts its pin). Admin-only", "description": "Restore a view's sidebar row (re-asserts its pin). Admin-only.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "viewName", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/sidebar": { "get": { "operationId": "crm_sidebar_list", "tags": [ "crm" ], "summary": "Describe the workspace sidebar: Library rows in tree order (with their groups), the home-level Pinned strip, what is hidden and why, and whether the caller is an admin", "description": "Describe the workspace sidebar: Library rows in tree order (with their groups), the home-level Pinned strip, what is hidden and why, and whether the caller is an admin.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "visible": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "hidden": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } }, "required": [ "visible", "hidden" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/sidebar/move": { "post": { "operationId": "crm_sidebar_move", "tags": [ "crm" ], "summary": "Reposition one Library row (or group) among the Library's top-level slots. Does not add a home-level Pinned tab. Workspace-shared; admin-only", "description": "Reposition one Library row (or group) among the Library's top-level slots. Does not add a home-level Pinned tab. Workspace-shared; admin-only.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "navId": { "type": "string", "description": "Nav id from `sidebar list`, e.g. crm-object:task." }, "position": { "anyOf": [ { "type": "string", "const": "top" }, { "type": "string", "const": "bottom" }, { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } ], "description": "Where to land among the visible rows; N is 1-based." } }, "required": [ "navId", "position" ] }, "example": { "navId": "string", "position": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "navId": { "type": "string" }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "visibleOrder": { "type": "array", "items": { "type": "string" } }, "error": { "type": "string" } }, "required": [ "ok", "navId", "position" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/sidebar/groups": { "post": { "operationId": "crm_sidebar_groups_create", "tags": [ "crm" ], "summary": "Create a named sidebar group (e.g. \"Hiring\") in the workspace-shared Library. Open to any member", "description": "Create a named sidebar group (e.g. \"Hiring\") in the workspace-shared Library. Open to any member.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/sidebar/groups/rename": { "post": { "operationId": "crm_sidebar_groups_rename", "tags": [ "crm" ], "summary": "Rename a sidebar group. Open to any member", "description": "Rename a sidebar group. Open to any member.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/sidebar/groups/delete": { "post": { "operationId": "crm_sidebar_groups_delete", "tags": [ "crm" ], "summary": "Dissolve a sidebar group; its rows return to the top level in its slot. Open to any member", "description": "Dissolve a sidebar group; its rows return to the top level in its slot. Open to any member.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/sidebar/groups/move": { "post": { "operationId": "crm_sidebar_groups_move-item", "tags": [ "crm" ], "summary": "Move a sidebar row into a group (groupId set) or back to the top level (groupId null). Open to any member", "description": "Move a sidebar row into a group (groupId set) or back to the top level (groupId null). Open to any member.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/sidebar/pins": { "post": { "operationId": "crm_sidebar_pins_set", "tags": [ "crm" ], "summary": "Pin (pinned true) or unpin a Library row — or a whole group — on the home-level Pinned shortcut strip (the \"tab on the left\"). Does not move the row inside Library. Workspace-shared; open to any member", "description": "Pin (pinned true) or unpin a Library row — or a whole group — on the home-level Pinned shortcut strip (the \"tab on the left\"). Does not move the row inside Library. Workspace-shared; open to any member.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/fields": { "get": { "operationId": "crm_fields_list", "tags": [ "crm" ], "summary": "List fields", "description": "List fields for a CRM object, including read-only calculation metadata.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "_creationTime": { "type": "number" }, "organizationId": { "type": "string" }, "objectId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "email", "phone", "url", "number", "boolean", "date", "richtext", "file", "user", "enum", "relation", "tags", "action" ], "description": "Field data type. `relation` needs relatedObjectName + relationshipType; `enum` uses enumValues/enumColors; `user` cells store one member userId or an array of member userIds; long prose belongs in the protected `Notes` richtext field." }, "required": { "type": "boolean" }, "defaultValue": { "type": "string" }, "calculation": { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign_activity" }, "metric": { "type": "string", "enum": [ "email_opened", "email_clicked", "replied", "linkedin_connected" ] }, "campaignId": { "description": "Same-workspace multichannel campaign ID readable by the viewer. Omit for any accessible multichannel campaign.", "type": "string", "minLength": 1 } }, "required": [ "kind", "metric" ], "additionalProperties": false, "description": "Read-only campaign activity boolean on people or lead (through Contact), not an expression. Cannot be required, indexed, enriched or have a default value." }, "relatedObjectId": { "type": "string" }, "relationshipType": { "type": "string", "enum": [ "many_to_one", "many_to_many" ], "description": "Relation cardinality for a `relation` field." }, "enumValues": { "type": "array", "items": { "type": "string" } }, "enumColors": { "type": "array", "items": { "type": "string" } }, "enumMultiple": { "type": "boolean" }, "sortOrder": { "type": "number" }, "indexed": { "type": "boolean" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "_id", "_creationTime", "organizationId", "objectId", "name", "type", "required", "sortOrder", "createdAt", "updatedAt" ], "additionalProperties": {}, "description": "A CRM field (column) document." } }, "example": [ { "_id": "fld_status01", "_creationTime": 1765526400000, "organizationId": "org_abc123", "objectId": "obj_lead01", "name": "Status", "type": "enum", "required": false, "enumValues": [ "New", "Working", "Qualified", "Lost" ], "enumColors": [ "#94a3b8", "#3b82f6", "#22c55e", "#ef4444" ], "enumMultiple": false, "sortOrder": 200, "indexed": true, "createdAt": 1765526400000, "updatedAt": 1765612800000 } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "operationId": "crm_fields_create", "tags": [ "crm" ], "summary": "Create field", "description": "Create a CRM field or read-only campaign activity boolean column.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "description": "Defaults to boolean with calculation, otherwise text. Calculations require boolean.", "type": "string", "enum": [ "text", "email", "phone", "url", "number", "boolean", "date", "richtext", "file", "user", "enum", "relation", "tags", "action" ] }, "required": { "type": "boolean" }, "defaultValue": { "type": "string" }, "relatedObjectName": { "description": "Target object for `relation` fields.", "type": "string" }, "relationshipType": { "type": "string", "enum": [ "many_to_one", "many_to_many" ], "description": "Relation cardinality for a `relation` field." }, "enumValues": { "description": "Options for `enum` fields.", "type": "array", "items": { "type": "string" } }, "enumColors": { "description": "Hex colors aligned to enumValues.", "type": "array", "items": { "type": "string" } }, "enumMultiple": { "description": "Allow multi-select enum.", "type": "boolean" }, "description": { "type": "string" }, "indexed": { "description": "Index for filter/search/sort.", "type": "boolean" }, "enrichment": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "people", "company" ] }, "key": { "type": "string" }, "apolloPath": { "type": "string" }, "inputFieldName": { "type": "string" } }, "required": [ "category", "key", "apolloPath" ], "additionalProperties": false, "description": "Enrichment binding that lets the field auto-fill from a provider." }, "calculation": { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign_activity" }, "metric": { "type": "string", "enum": [ "email_opened", "email_clicked", "replied", "linkedin_connected" ] }, "campaignId": { "description": "Same-workspace multichannel campaign ID readable by the viewer. Omit for any accessible multichannel campaign.", "type": "string", "minLength": 1 } }, "required": [ "kind", "metric" ], "additionalProperties": false, "description": "Read-only campaign activity boolean on people or lead (through Contact), not an expression. Cannot be required, indexed, enriched or have a default value." } }, "required": [ "name" ] }, "example": { "name": "Status", "type": "enum", "enumValues": [ "New", "Working", "Qualified", "Lost" ], "enumColors": [ "#94a3b8", "#3b82f6", "#22c55e", "#ef4444" ], "indexed": true } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, "example": { "id": "fld_score01" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/catalog/objects/{objectName}/fields": { "get": { "operationId": "crm_fields_listCompact", "tags": [ "crm" ], "summary": "List field names, types and effective constraints without indexing or enrichment internals", "description": "List field names, types and effective constraints without indexing or enrichment internals.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "defaultValue": { "type": "string" }, "enumValues": { "type": "array", "items": { "type": "string" } }, "enumMultiple": { "type": "boolean" }, "relatedObjectId": { "type": "string" }, "relationshipType": { "type": "string" } }, "required": [ "_id", "name", "type", "required", "readOnly", "enumMultiple" ], "additionalProperties": false } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/fields/{fieldName}": { "patch": { "operationId": "crm_fields_update", "tags": [ "crm" ], "summary": "Update field", "description": "Update a CRM field or change/explicitly clear an existing campaign calculation.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "Rename the field.", "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "enumValues": { "description": "Full replacement of options.", "type": "array", "items": { "type": "string" } }, "enumColors": { "type": "array", "items": { "type": "string" } }, "enumMultiple": { "type": "boolean" }, "indexed": { "type": "boolean" }, "enrichment": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "people", "company" ] }, "key": { "type": "string" }, "apolloPath": { "type": "string" }, "inputFieldName": { "type": "string" } }, "required": [ "category", "key", "apolloPath" ], "additionalProperties": false, "description": "Enrichment binding that lets the field auto-fill from a provider." }, "clearEnrichment": { "type": "boolean" }, "calculation": { "description": "Replace an existing calculation's metric/source. Stored fields cannot be converted; create a new column instead.", "type": "object", "properties": { "kind": { "type": "string", "const": "campaign_activity" }, "metric": { "type": "string", "enum": [ "email_opened", "email_clicked", "replied", "linkedin_connected" ] }, "campaignId": { "description": "Same-workspace multichannel campaign ID readable by the viewer. Omit for any accessible multichannel campaign.", "type": "string", "minLength": 1 } }, "required": [ "kind", "metric" ], "additionalProperties": false }, "clearCalculation": { "description": "Explicitly remove an existing calculation, leaving an editable boolean. Does not snapshot calculated values. Mutually exclusive with calculation.", "type": "boolean" } } } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false }, "example": { "ok": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "delete": { "operationId": "crm_fields_delete", "tags": [ "crm" ], "summary": "Delete field", "description": "Delete a CRM field.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false }, "example": { "ok": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/fields/reorder": { "post": { "operationId": "crm_fields_reorder", "tags": [ "crm" ], "summary": "Reorder fields", "description": "Reorder CRM fields.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "orderedFieldNames": { "type": "array", "items": { "type": "string" }, "description": "Field names in desired order." } }, "required": [ "orderedFieldNames" ] }, "example": { "orderedFieldNames": [] } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false }, "example": { "ok": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/fields/{fieldName}/enum/reorder": { "post": { "operationId": "crm_fields_enum_reorder", "tags": [ "crm" ], "summary": "Reorder enum values", "description": "Reorder enum values.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "orderedValues": { "type": "array", "items": { "type": "string" }, "description": "Exact permutation of existing options." } }, "required": [ "orderedValues" ] }, "example": { "orderedValues": [] } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "enumValues": { "type": "array", "items": { "type": "string" } }, "enumColors": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "ok", "enumValues", "enumColors" ], "additionalProperties": false }, "example": { "ok": true, "enumValues": [ "New", "Qualified", "Working", "Lost" ], "enumColors": [ "#94a3b8", "#22c55e", "#3b82f6", "#ef4444" ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/fields/{fieldName}/enum": { "post": { "operationId": "crm_fields_enum_add", "tags": [ "crm" ], "summary": "Add enum value", "description": "Add an enum value.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string", "description": "Option value to add." }, "color": { "description": "Hex color for the option.", "type": "string" }, "position": { "description": "0-based insert index; defaults to append.", "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "value" ] }, "example": { "value": "Nurturing", "color": "#eab308", "position": 2 } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "enumValues": { "type": "array", "items": { "type": "string" } }, "enumColors": { "type": "array", "items": { "type": "string" } }, "inserted": { "type": "boolean" } }, "required": [ "ok", "enumValues", "enumColors", "inserted" ], "additionalProperties": false }, "example": { "ok": true, "enumValues": [ "New", "Working", "Nurturing", "Qualified", "Lost" ], "enumColors": [ "#94a3b8", "#3b82f6", "#eab308", "#22c55e", "#ef4444" ], "inserted": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/fields/{fieldName}/enum/{value}": { "delete": { "operationId": "crm_fields_enum_remove", "tags": [ "crm" ], "summary": "Remove enum value", "description": "Remove an enum value.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "enumValues": { "type": "array", "items": { "type": "string" } }, "enumColors": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "removed": { "type": "boolean" } }, "required": [ "ok", "enumValues", "enumColors", "removed" ], "additionalProperties": false }, "example": { "ok": true, "enumValues": [ "New", "Working", "Qualified" ], "enumColors": [ "#94a3b8", "#3b82f6", "#22c55e" ], "removed": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/fields/{fieldName}/enum/{oldValue}/rename": { "post": { "operationId": "crm_fields_enum_rename", "tags": [ "crm" ], "summary": "Rename enum value", "description": "Rename an enum value.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "oldValue", "in": "path", "required": true, "schema": { "type": "string", "description": "Existing option value (path)." }, "description": "Existing option value (path)." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "newValue": { "type": "string", "description": "New option value; migrates entries + statuses." } }, "required": [ "newValue" ] }, "example": { "newValue": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "enumValues": { "type": "array", "items": { "type": "string" } }, "enumColors": { "type": "array", "items": { "type": "string" } }, "entriesUpdated": { "type": "number" } }, "required": [ "ok", "enumValues", "enumColors", "entriesUpdated" ], "additionalProperties": false }, "example": { "ok": true, "enumValues": [ "New", "Working", "Closed Won", "Lost" ], "enumColors": [ "#94a3b8", "#3b82f6", "#22c55e", "#ef4444" ], "entriesUpdated": 7 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/fields/{fieldName}/enum/{value}/color": { "post": { "operationId": "crm_fields_enum_color", "tags": [ "crm" ], "summary": "Set enum color", "description": "Set an enum color.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "color": { "type": "string", "description": "Hex color, e.g. #22c55e." } }, "required": [ "color" ] }, "example": { "color": "#22c55e" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "enumColors": { "type": "array", "items": { "type": "string" } } }, "required": [ "ok", "enumColors" ], "additionalProperties": false }, "example": { "ok": true, "enumColors": [ "#94a3b8", "#3b82f6", "#22c55e", "#ef4444" ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries": { "get": { "operationId": "crm_entries_list", "tags": [ "crm" ], "summary": "List entries", "description": "List CRM entries.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "withReferences", "in": "query", "required": false, "schema": { "description": "Include bounded navigation references. Array reads return {data, references, referenceCoverage}; existing result envelopes keep their fields.", "type": "boolean" }, "description": "Include bounded navigation references. Array reads return {data, references, referenceCoverage}; existing result envelopes keep their fields." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "assignedTo", "in": "query", "required": false, "schema": { "description": "Personal scope: \"me\" (the signed-in member / the human behind an agent session), \"unassigned\", or a member userId or email. Adds one has_any / is_empty rule on the object's assignee user field; rows, totalCount, sums and analytics all follow it. Never saved onto the view.", "type": "string" }, "description": "Personal scope: \"me\" (the signed-in member / the human behind an agent session), \"unassigned\", or a member userId or email. Adds one has_any / is_empty rule on the object's assignee user field; rows, totalCount, sums and analytics all follow it. Never saved onto the view." }, { "name": "assigneeField", "in": "query", "required": false, "schema": { "description": "Which `user` field \"assigned\" means. Default: the analytics owner role, else the task `Assignee`, else a user field named like owner/assignee, else the first user field.", "type": "string" }, "description": "Which `user` field \"assigned\" means. Default: the analytics owner role, else the task `Assignee`, else a user field named like owner/assignee, else the first user field." } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "objectId": { "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Field-name -> cell value map." }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "updatedBy": { "type": "string" }, "sortOrder": { "type": "number" } }, "required": [ "id", "objectId", "fields", "createdAt", "updatedAt", "updatedBy", "sortOrder" ], "additionalProperties": false, "description": "A materialized CRM entry (row)." } }, { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "objectId": { "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Field-name -> cell value map." }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "updatedBy": { "type": "string" }, "sortOrder": { "type": "number" } }, "required": [ "id", "objectId", "fields", "createdAt", "updatedAt", "updatedBy", "sortOrder" ], "additionalProperties": false, "description": "A materialized CRM entry (row)." } }, "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false } }, "required": [ "data", "references", "referenceCoverage" ], "additionalProperties": false } ] }, "example": [ { "id": "ent_lead99", "objectId": "obj_lead01", "fields": { "Name": "Ada Lovelace", "Email": "ada@example.com", "Status": "New" }, "createdAt": 1765526400000, "updatedAt": 1765612800000, "updatedBy": "user:us_xyz789", "sortOrder": 0 } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "operationId": "crm_entries_create", "tags": [ "crm" ], "summary": "Create entry", "description": "Create a CRM entry.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Field-name -> value map. For `user` fields use one member userId or a userId array; preserve every assignee." } }, "required": [ "data" ] }, "example": { "data": { "Name": "Joint review", "Assignee": [ "user_kumar", "user_mark" ], "Status": "New" } } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "entryId": { "type": "string" }, "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false } }, "required": [ "entryId" ], "additionalProperties": false }, "example": { "entryId": "ent_lead99" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/{entryId}": { "get": { "operationId": "crm_entries_get", "tags": [ "crm" ], "summary": "Get entry", "description": "Get a CRM entry.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "objectId": { "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Field-name -> cell value map." }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "updatedBy": { "type": "string" }, "sortOrder": { "type": "number" }, "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false } }, "required": [ "id", "objectId", "fields", "createdAt", "updatedAt", "updatedBy", "sortOrder" ], "additionalProperties": false }, { "type": "null" } ] }, "example": { "id": "ent_lead99", "objectId": "obj_lead01", "fields": { "Name": "Ada Lovelace", "Email": "ada@example.com", "Status": "New" }, "createdAt": 1765526400000, "updatedAt": 1765612800000, "updatedBy": "user:us_xyz789", "sortOrder": 0 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "patch": { "operationId": "crm_entries_update", "tags": [ "crm" ], "summary": "Update entry", "description": "Update a CRM entry.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Field-name -> value map. For `user` fields use one member userId or a userId array; preserve every assignee." } }, "required": [ "data" ] }, "example": { "data": {} } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "entryId": { "type": "string" }, "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false } }, "required": [ "entryId" ], "additionalProperties": false }, "example": { "entryId": "ent_lead99" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "delete": { "operationId": "crm_entries_delete", "tags": [ "crm" ], "summary": "Delete entry", "description": "Delete a CRM entry.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false }, "example": { "ok": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/{entryId}/sync-history": { "post": { "operationId": "crm_entries_syncHistory", "tags": [ "crm" ], "summary": "Queue a full, paged pull of the record's email history from every connected mailbox; the ledger fills as pages land", "description": "Queue a full, paged pull of the record's email history from every connected mailbox; the ledger fills as pages land.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "get": { "operationId": "crm_entries_syncHistoryStatus", "tags": [ "crm" ], "summary": "Has Dench read this record's email history? One row per address per mailbox", "description": "Has Dench read this record's email history? One row per address per mailbox.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/entries/{entryId}/dossier": { "get": { "operationId": "crm_entries_dossier_get", "tags": [ "crm" ], "summary": "Status of the account's research dossier — the delimited `dench:dossier` section Dench keeps in the record's Notes: status, when it was written, how many dated updates followed, the last error", "description": "Status of the account's research dossier — the delimited `dench:dossier` section Dench keeps in the record's Notes: status, when it was written, how many dated updates followed, the last error.", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/entries/{entryId}/dossier/regenerate": { "post": { "operationId": "crm_entries_dossier_regenerate", "tags": [ "crm" ], "summary": "Research the account again and append a fresh dossier section to its Notes (needs a Website / Domain on the record)", "description": "Research the account again and append a fresh dossier section to its Notes (needs a Website / Domain on the record).", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/entries/{entryId}/privacy": { "get": { "operationId": "crm_privacy_get", "tags": [ "crm" ], "summary": "Whether the caller hides their own emails / messages with this record from the workspace (directly, or through its account), and whether they own a connection the toggle applies to", "description": "Whether the caller hides their own emails / messages with this record from the workspace (directly, or through its account), and whether they own a connection the toggle applies to.", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "put": { "operationId": "crm_privacy_set", "tags": [ "crm" ], "summary": "Hide (`hidden: true`) or show the caller's own emails / messages with this record to the workspace. An account covers every contact and opportunity linked to it; existing ledger rows are restamped and the shared Brief regenerates", "description": "Hide (`hidden: true`) or show the caller's own emails / messages with this record to the workspace. An account covers every contact and opportunity linked to it; existing ledger rows are restamped and the shared Brief regenerates.", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "hidden": { "type": "boolean" } }, "required": [ "hidden" ] }, "example": { "hidden": true } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/detections": { "get": { "operationId": "crm_detections_list", "tags": [ "crm" ], "summary": "List account-detection verdicts — why a domain (or personal address) did or did not become an account: verdict, counterparty type, probabilities, evidence threads, the rows created. `kind` picks the creator: `detections` (email + sweep), `linkedin` (the LinkedIn resolver's rows) or `all` (default). Newest first", "description": "List account-detection verdicts — why a domain (or personal address) did or did not become an account: verdict, counterparty type, probabilities, evidence threads, the rows created. `kind` picks the creator: `detections` (email + sweep), `linkedin` (the LinkedIn resolver's rows) or `all` (default). Newest first.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/detections/undo": { "post": { "operationId": "crm_detections_undo", "tags": [ "crm" ], "summary": "Undo what the ingestion jobs created since a timestamp (admin): `kind` = `detections` (accounts + contacts from the email detector and the sweep), `linkedin` (the LinkedIn resolver's contacts + accounts; their conversations are unlinked and parked), `email-tasks` (auto-created tasks and cases) or `all` (default). Deletes only rows no human has touched and marks the verdicts / decisions rolled_back so they are never re-created. `dryRun` lists what would go; per-kind counts in `kinds`", "description": "Undo what the ingestion jobs created since a timestamp (admin): `kind` = `detections` (accounts + contacts from the email detector and the sweep), `linkedin` (the LinkedIn resolver's contacts + accounts; their conversations are unlinked and parked), `email-tasks` (auto-created tasks and cases) or `all` (default). Deletes only rows no human has touched and marks the verdicts / decisions rolled_back so they are never re-created. `dryRun` lists what would go; per-kind counts in `kinds`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "since": { "type": "number", "description": "Only verdicts / decisions at or after this ms timestamp." }, "kind": { "description": "Which creator's rows to undo. Default `all`.", "type": "string", "enum": [ "detections", "linkedin", "email-tasks", "all" ] }, "dryRun": { "type": "boolean" }, "limit": { "type": "integer", "minimum": 1, "maximum": 50 } }, "required": [ "since" ] }, "example": { "since": 0 } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/{entryId}/history": { "get": { "operationId": "crm_entries_history", "tags": [ "crm" ], "summary": "List a CRM entry's audit history", "description": "List a CRM entry's audit history.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/{entryId}/activity": { "get": { "operationId": "crm_activity_list", "tags": [ "crm" ], "summary": "List a CRM entry's activity ledger (comments, notes, field changes, emails, meetings, Slack, LinkedIn) in one timeline, newest first by default", "description": "List a CRM entry's activity ledger (comments, notes, field changes, emails, meetings, Slack, LinkedIn) in one timeline, newest first by default.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/{entryId}/brief": { "get": { "operationId": "crm_brief_get", "tags": [ "crm" ], "summary": "The record's generated Brief: health, who owes the next move, open threads, commitments, risks, next step. Read this before the ledger", "description": "The record's generated Brief: health, who owes the next move, open threads, commitments, risks, next step. Read this before the ledger.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/{entryId}/context": { "get": { "operationId": "crm_context_get", "tags": [ "crm" ], "summary": "Read-only source diagnostics: accessible evidence, association reasons, last Brief source manifest, generation queue, and your mailbox delivery health. Bounded, cursor-paged snapshot; does not certify complete history", "description": "Read-only source diagnostics: accessible evidence, association reasons, last Brief source manifest, generation queue, and your mailbox delivery health. Bounded, cursor-paged snapshot; does not certify complete history.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/{entryId}/brief/regenerate": { "post": { "operationId": "crm_brief_regenerate", "tags": [ "crm" ], "summary": "Rebuild a record's Brief from the current timeline", "description": "Rebuild a record's Brief from the current timeline.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/{entryId}/activity/count": { "get": { "operationId": "crm_activity_count", "tags": [ "crm" ], "summary": "Bounded per-source counts of a CRM entry's activity ledger", "description": "Bounded per-source counts of a CRM entry's activity ledger.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/{entryId}/notes": { "get": { "operationId": "crm_notes_list", "tags": [ "crm" ], "summary": "List a CRM entry's notes (titled, document-style comments), newest first", "description": "List a CRM entry's notes (titled, document-style comments), newest first.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "operationId": "crm_notes_create", "tags": [ "crm" ], "summary": "Add a titled note to a CRM entry's activity timeline (markdown body). Research goes here, never into the Notes document", "description": "Add a titled note to a CRM entry's activity timeline (markdown body). Research goes here, never into the Notes document.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/{entryId}/comments": { "get": { "operationId": "crm_comments_list", "tags": [ "crm" ], "summary": "List comments on a CRM entry (roots newest first, with preview replies)", "description": "List comments on a CRM entry (roots newest first, with preview replies).", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "description": "continueCursor from the prior page.", "type": "string" }, "description": "continueCursor from the prior page." }, { "name": "replies", "in": "query", "required": false, "schema": { "description": "Preview replies per root (default 2).", "type": "integer", "minimum": 0, "maximum": 50 }, "description": "Preview replies per root (default 2)." } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "entryId": { "type": "string" }, "parentCommentId": { "type": "string" }, "rootCommentId": { "type": "string" }, "depth": { "type": "number" }, "body": { "type": "string", "description": "Markdown." }, "actor": { "type": "object", "properties": { "kind": { "type": "string" }, "label": { "type": "string" }, "displayName": { "type": "string" }, "imageUrl": { "type": "string" }, "userId": { "type": "string" }, "isDench": { "type": "boolean" } }, "required": [ "kind", "label", "isDench" ], "additionalProperties": {} }, "mentionedUserIds": { "type": "array", "items": { "type": "string" } }, "mentionsDench": { "type": "boolean" }, "replyCount": { "type": "number" }, "reactionSummary": { "type": "array", "items": { "type": "object", "properties": { "emoji": { "type": "string" }, "count": { "type": "number" } }, "required": [ "emoji", "count" ], "additionalProperties": false } }, "viewerReactions": { "type": "array", "items": { "type": "string" } }, "editedAt": { "type": "number" }, "deletedAt": { "type": "number" }, "denchStatus": { "type": "string", "enum": [ "pending", "failed", "done" ] }, "canEdit": { "type": "boolean" }, "createdAt": { "type": "number" }, "replies": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "entryId": { "type": "string" }, "parentCommentId": { "type": "string" }, "rootCommentId": { "type": "string" }, "depth": { "type": "number" }, "body": { "type": "string", "description": "Markdown." }, "actor": { "type": "object", "properties": { "kind": { "type": "string" }, "label": { "type": "string" }, "displayName": { "type": "string" }, "imageUrl": { "type": "string" }, "userId": { "type": "string" }, "isDench": { "type": "boolean" } }, "required": [ "kind", "label", "isDench" ], "additionalProperties": {} }, "mentionedUserIds": { "type": "array", "items": { "type": "string" } }, "mentionsDench": { "type": "boolean" }, "replyCount": { "type": "number" }, "reactionSummary": { "type": "array", "items": { "type": "object", "properties": { "emoji": { "type": "string" }, "count": { "type": "number" } }, "required": [ "emoji", "count" ], "additionalProperties": false } }, "viewerReactions": { "type": "array", "items": { "type": "string" } }, "editedAt": { "type": "number" }, "deletedAt": { "type": "number" }, "denchStatus": { "type": "string", "enum": [ "pending", "failed", "done" ] }, "canEdit": { "type": "boolean" }, "createdAt": { "type": "number" } }, "required": [ "_id", "entryId", "depth", "body", "actor", "mentionedUserIds", "mentionsDench", "replyCount", "reactionSummary", "viewerReactions", "canEdit", "createdAt" ], "additionalProperties": {}, "description": "A comment on a CRM entry." } } }, "required": [ "_id", "entryId", "depth", "body", "actor", "mentionedUserIds", "mentionsDench", "replyCount", "reactionSummary", "viewerReactions", "canEdit", "createdAt", "replies" ], "additionalProperties": {} } }, "isDone": { "type": "boolean" }, "continueCursor": { "type": "string" } }, "required": [ "page", "isDone", "continueCursor" ], "additionalProperties": false }, "example": { "page": [ { "_id": "cmt_01", "entryId": "ent_lead99", "depth": 0, "body": "Kickoff went well — [@Bob](/?member=user_bob) can you send the proposal?", "actor": { "kind": "user", "label": "Ada", "displayName": "Ada Lovelace", "userId": "user_ada", "isDench": false }, "mentionedUserIds": [ "user_bob" ], "mentionsDench": false, "replyCount": 1, "reactionSummary": [ { "emoji": "👍", "count": 2 } ], "viewerReactions": [ "👍" ], "canEdit": true, "createdAt": 1765526400000, "replies": [ { "_id": "cmt_02", "entryId": "ent_lead99", "parentCommentId": "cmt_01", "rootCommentId": "cmt_01", "depth": 1, "body": "On it.", "actor": { "kind": "user", "label": "Bob", "displayName": "Bob Smith", "userId": "user_bob", "isDench": false }, "mentionedUserIds": [], "mentionsDench": false, "replyCount": 0, "reactionSummary": [], "viewerReactions": [], "canEdit": false, "createdAt": 1765530000000 } ] } ], "isDone": true, "continueCursor": "" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "operationId": "crm_comments_create", "tags": [ "crm" ], "summary": "Comment on a CRM entry (markdown). Mention members with [@Name](/?member=); mention Dench with [@Dench](/?member=dench) or mentionDench", "description": "Comment on a CRM entry (markdown). Mention members with [@Name](/?member=); mention Dench with [@Dench](/?member=dench) or mentionDench.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string", "minLength": 1, "description": "Markdown. Mention a member with [@Name](/?member=); mention Dench with [@Dench](/?member=dench)." }, "parentCommentId": { "description": "Reply under this comment (any depth).", "type": "string" }, "mentionUserIds": { "description": "Extra members to notify without writing mention links.", "type": "array", "items": { "type": "string" } }, "mentionDench": { "description": "Summon Dench to reply in the thread.", "type": "boolean" } }, "required": [ "body" ] }, "example": { "body": "Kickoff went well — [@Bob](/?member=user_bob) can you send the proposal? [@Dench](/?member=dench) what's the ARR here?" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "rootCommentId": { "type": "string" }, "depth": { "type": "number" }, "mentionedUserIds": { "type": "array", "items": { "type": "string" } }, "mentionsDench": { "type": "boolean" } }, "required": [ "id", "depth", "mentionedUserIds", "mentionsDench" ], "additionalProperties": false }, "example": { "id": "cmt_03", "rootCommentId": "cmt_01", "depth": 1, "mentionedUserIds": [ "user_bob" ], "mentionsDench": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/comments/{commentId}/replies": { "get": { "operationId": "crm_comments_replies", "tags": [ "crm" ], "summary": "List every reply under a root comment, oldest first", "description": "List every reply under a root comment, oldest first.", "parameters": [ { "name": "commentId", "in": "path", "required": true, "schema": { "type": "string", "description": "Root comment id." }, "description": "Root comment id." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "entryId": { "type": "string" }, "parentCommentId": { "type": "string" }, "rootCommentId": { "type": "string" }, "depth": { "type": "number" }, "body": { "type": "string", "description": "Markdown." }, "actor": { "type": "object", "properties": { "kind": { "type": "string" }, "label": { "type": "string" }, "displayName": { "type": "string" }, "imageUrl": { "type": "string" }, "userId": { "type": "string" }, "isDench": { "type": "boolean" } }, "required": [ "kind", "label", "isDench" ], "additionalProperties": {} }, "mentionedUserIds": { "type": "array", "items": { "type": "string" } }, "mentionsDench": { "type": "boolean" }, "replyCount": { "type": "number" }, "reactionSummary": { "type": "array", "items": { "type": "object", "properties": { "emoji": { "type": "string" }, "count": { "type": "number" } }, "required": [ "emoji", "count" ], "additionalProperties": false } }, "viewerReactions": { "type": "array", "items": { "type": "string" } }, "editedAt": { "type": "number" }, "deletedAt": { "type": "number" }, "denchStatus": { "type": "string", "enum": [ "pending", "failed", "done" ] }, "canEdit": { "type": "boolean" }, "createdAt": { "type": "number" } }, "required": [ "_id", "entryId", "depth", "body", "actor", "mentionedUserIds", "mentionsDench", "replyCount", "reactionSummary", "viewerReactions", "canEdit", "createdAt" ], "additionalProperties": {}, "description": "A comment on a CRM entry." } }, "isDone": { "type": "boolean" }, "continueCursor": { "type": "string" } }, "required": [ "page", "isDone", "continueCursor" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/comments/{commentId}": { "get": { "operationId": "crm_comments_get", "tags": [ "crm" ], "summary": "Get one comment with its entry label", "description": "Get one comment with its entry label.", "parameters": [ { "name": "commentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "entryId": { "type": "string" }, "parentCommentId": { "type": "string" }, "rootCommentId": { "type": "string" }, "depth": { "type": "number" }, "body": { "type": "string", "description": "Markdown." }, "actor": { "type": "object", "properties": { "kind": { "type": "string" }, "label": { "type": "string" }, "displayName": { "type": "string" }, "imageUrl": { "type": "string" }, "userId": { "type": "string" }, "isDench": { "type": "boolean" } }, "required": [ "kind", "label", "isDench" ], "additionalProperties": {} }, "mentionedUserIds": { "type": "array", "items": { "type": "string" } }, "mentionsDench": { "type": "boolean" }, "replyCount": { "type": "number" }, "reactionSummary": { "type": "array", "items": { "type": "object", "properties": { "emoji": { "type": "string" }, "count": { "type": "number" } }, "required": [ "emoji", "count" ], "additionalProperties": false } }, "viewerReactions": { "type": "array", "items": { "type": "string" } }, "editedAt": { "type": "number" }, "deletedAt": { "type": "number" }, "denchStatus": { "type": "string", "enum": [ "pending", "failed", "done" ] }, "canEdit": { "type": "boolean" }, "createdAt": { "type": "number" }, "objectName": { "type": "string" }, "entryLabel": { "type": "string" } }, "required": [ "_id", "entryId", "depth", "body", "actor", "mentionedUserIds", "mentionsDench", "replyCount", "reactionSummary", "viewerReactions", "canEdit", "createdAt", "objectName", "entryLabel" ], "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "patch": { "operationId": "crm_comments_update", "tags": [ "crm" ], "summary": "Edit a comment you wrote", "description": "Edit a comment you wrote.", "parameters": [ { "name": "commentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string", "minLength": 1 } }, "required": [ "body" ] }, "example": { "body": "Kickoff went well — proposal sent." } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "newlyMentioned": { "type": "array", "items": { "type": "string" } } }, "required": [ "ok", "newlyMentioned" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "delete": { "operationId": "crm_comments_delete", "tags": [ "crm" ], "summary": "Delete a comment (kept as a tombstone when it has replies)", "description": "Delete a comment (kept as a tombstone when it has replies).", "parameters": [ { "name": "commentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "tombstoned": { "type": "boolean" } }, "required": [ "ok", "tombstoned" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/comments/{commentId}/reactions/{emoji}": { "put": { "operationId": "crm_comments_react", "tags": [ "crm" ], "summary": "Toggle an emoji reaction on a comment", "description": "Toggle an emoji reaction on a comment.", "parameters": [ { "name": "commentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "emoji", "in": "path", "required": true, "schema": { "type": "string", "description": "A single emoji, e.g. 👍." }, "description": "A single emoji, e.g. 👍." } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "reacted": { "type": "boolean" }, "reactionSummary": { "type": "array", "items": { "type": "object", "properties": { "emoji": { "type": "string" }, "count": { "type": "number" } }, "required": [ "emoji", "count" ], "additionalProperties": false } } }, "required": [ "reacted", "reactionSummary" ], "additionalProperties": false }, "example": { "reacted": true, "reactionSummary": [ { "emoji": "👍", "count": 3 } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/{entryId}/watch": { "get": { "operationId": "crm_watch_get", "tags": [ "crm" ], "summary": "Whether you follow a CRM entry's activity", "description": "Whether you follow a CRM entry's activity.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "watching": { "type": "boolean" }, "reason": { "type": "string" }, "watcherCount": { "type": "number" } }, "required": [ "watching", "watcherCount" ], "additionalProperties": false }, "example": { "watching": true, "reason": "commented", "watcherCount": 3 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "put": { "operationId": "crm_watch_set", "tags": [ "crm" ], "summary": "Follow or unfollow a CRM entry's activity", "description": "Follow or unfollow a CRM entry's activity.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "watching": { "description": "Defaults to true; false unfollows.", "type": "boolean" } } }, "example": { "watching": true } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "watching": { "type": "boolean" } }, "required": [ "watching" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/tasks/assigned/page": { "post": { "operationId": "crm_tasks_pageAssigned", "tags": [ "crm" ], "summary": "Page assigned tasks in priority order (or completed tasks by recency)", "description": "Page assigned tasks in priority order (or completed tasks by recency).", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/{entryId}/tasks/page": { "post": { "operationId": "crm_tasks_pageForEntry", "tags": [ "crm" ], "summary": "Page all tasks linked to a record, including subtasks", "description": "Page all tasks linked to a record, including subtasks.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/tasks/prepare": { "post": { "operationId": "crm_tasks_prepare", "tags": [ "crm" ], "summary": "Start or resume preparation of exact task ordering and progress", "description": "Start or resume preparation of exact task ordering and progress.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/tasks/mine": { "get": { "operationId": "crm_tasks_mine", "tags": [ "crm" ], "summary": "Your open tasks (plus ones completed today)", "description": "Your open tasks (plus ones completed today).", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "priority", "in": "query", "required": false, "schema": { "description": "Only tasks at this priority — one of the workspace's Priority options (\"high\"; case-insensitive).", "type": "string" }, "description": "Only tasks at this priority — one of the workspace's Priority options (\"high\"; case-insensitive)." } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/{entryId}/tasks": { "get": { "operationId": "crm_tasks_forEntry", "tags": [ "crm" ], "summary": "Tasks linked to a CRM entry", "description": "Tasks linked to a CRM entry.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "operationId": "crm_tasks_createForEntry", "tags": [ "crm" ], "summary": "Create a task linked to a CRM entry", "description": "Create a task linked to a CRM entry.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "assigneeUserId": { "type": "string" }, "dueDateKey": { "description": "YYYY-MM-DD", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "priority": { "description": "One of the workspace's Priority options (default Low | Medium | High; case-insensitive).", "type": "string" } }, "required": [ "name" ] }, "example": { "name": "Send proposal", "assigneeUserId": "user_bob", "dueDateKey": "2026-09-05" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/tasks/{entryId}/complete": { "post": { "operationId": "crm_tasks_complete", "tags": [ "crm" ], "summary": "Mark a task done", "description": "Mark a task done.", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/tasks/{entryId}/reopen": { "post": { "operationId": "crm_tasks_reopen", "tags": [ "crm" ], "summary": "Reopen a completed task", "description": "Reopen a completed task.", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/tasks/{entryId}/priority": { "put": { "operationId": "crm_tasks_setPriority", "tags": [ "crm" ], "summary": "Set or clear a task's priority", "description": "Set or clear a task's priority.", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "priority": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "One of the workspace's Priority options (\"high\"; case-insensitive), or null to clear." } }, "required": [ "priority" ] }, "example": { "priority": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/tasks/{entryId}/subtasks": { "get": { "operationId": "crm_tasks_subtasks_list", "tags": [ "crm" ], "summary": "A task's subtasks", "description": "A task's subtasks.", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "operationId": "crm_tasks_subtasks_create", "tags": [ "crm" ], "summary": "Create a subtask under a task (inherits the parent's record relations)", "description": "Create a subtask under a task (inherits the parent's record relations).", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string", "description": "The parent task." }, "description": "The parent task." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "assigneeUserId": { "type": "string" }, "dueDateKey": { "description": "YYYY-MM-DD", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "priority": { "type": "string" } }, "required": [ "name" ] }, "example": { "name": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/tasks/{entryId}/parent": { "put": { "operationId": "crm_tasks_setParent", "tags": [ "crm" ], "summary": "Nest a task under a parent, or promote it (parentEntryId: null)", "description": "Nest a task under a parent, or promote it (parentEntryId: null).", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "parentEntryId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The parent task, or null to promote to a top-level task." } }, "required": [ "parentEntryId" ] }, "example": { "parentEntryId": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/tasks/{entryId}": { "delete": { "operationId": "crm_tasks_delete", "tags": [ "crm" ], "summary": "Delete a task and its subtasks, or keep them as tasks", "description": "Delete a task and its subtasks, or keep them as tasks.", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "subtasks": { "description": "What happens to its subtasks: delete them too (default) or keep them as tasks.", "type": "string", "enum": [ "delete", "keep" ] } } } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/tasks/{entryId}/repeat": { "get": { "operationId": "crm_tasks_repeat_get", "tags": [ "crm" ], "summary": "How a task repeats (rule, RRULE, trigger, ends, next due)", "description": "How a task repeats (rule, RRULE, trigger, ends, next due).", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "put": { "operationId": "crm_tasks_repeat_set", "tags": [ "crm" ], "summary": "Make a task repeat, or change how it repeats (JSON rule or RRULE). An undated task gets its due date anchored on the first matching day from today", "description": "Make a task repeat, or change how it repeats (JSON rule or RRULE). An undated task gets its due date anchored on the first matching day from today.", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "rule": { "description": "Structured rule; alternative to `rrule`.", "oneOf": [ { "type": "object", "properties": { "freq": { "type": "string", "const": "daily" }, "interval": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": [ "freq", "interval" ], "additionalProperties": false }, { "type": "object", "properties": { "freq": { "type": "string", "const": "weekly" }, "interval": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "byWeekday": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "mo", "tu", "we", "th", "fr", "sa", "su" ] } } }, "required": [ "freq", "interval", "byWeekday" ], "additionalProperties": false }, { "type": "object", "properties": { "freq": { "type": "string", "const": "monthly" }, "interval": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "byMonthDay": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "1–31, or -1 for the last day of the month." }, "bySetPos": { "type": "object", "properties": { "ordinal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "1–4, or -1 for the last week." }, "weekday": { "type": "string", "enum": [ "mo", "tu", "we", "th", "fr", "sa", "su" ] } }, "required": [ "ordinal", "weekday" ], "additionalProperties": false } }, "required": [ "freq", "interval" ], "additionalProperties": false }, { "type": "object", "properties": { "freq": { "type": "string", "const": "yearly" }, "interval": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "day": { "type": "integer", "minimum": 1, "maximum": 31 } }, "required": [ "freq", "interval", "month", "day" ], "additionalProperties": false } ] }, "rrule": { "description": "RFC 5545 subset: FREQ, INTERVAL, BYDAY (ordinal allowed for MONTHLY, e.g. 2TU / -1FR), BYMONTHDAY, BYMONTH, COUNT, UNTIL. Bare FREQ=MONTHLY / YEARLY / WEEKLY take the day from the task's due date.", "type": "string" }, "trigger": { "description": "When the next occurrence is created: after this one is done (default) or on schedule regardless.", "type": "string", "enum": [ "after_completion", "on_schedule" ] }, "ends": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "never" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "count" }, "count": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": [ "kind", "count" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "until" }, "dateKey": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "kind", "dateKey" ], "additionalProperties": false } ] }, "options": { "type": "object", "properties": { "skipWeekends": { "type": "boolean" }, "keepAssignee": { "type": "boolean" }, "copyNotes": { "type": "boolean" }, "copySubtasks": { "type": "boolean" } }, "additionalProperties": false } } } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "delete": { "operationId": "crm_tasks_repeat_clear", "tags": [ "crm" ], "summary": "Stop a task repeating (past occurrences are kept)", "description": "Stop a task repeating (past occurrences are kept).", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "null" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/tasks/{entryId}/repeat/skip": { "post": { "operationId": "crm_tasks_repeat_skip", "tags": [ "crm" ], "summary": "Skip the current occurrence: the next one is created now", "description": "Skip the current occurrence: the next one is created now.", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": {} } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/tasks/{entryId}/repeat/pause": { "post": { "operationId": "crm_tasks_repeat_pause", "tags": [ "crm" ], "summary": "Pause a repeating task", "description": "Pause a repeating task.", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "null" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/tasks/{entryId}/repeat/resume": { "post": { "operationId": "crm_tasks_repeat_resume", "tags": [ "crm" ], "summary": "Resume a paused repeating task", "description": "Resume a paused repeating task.", "parameters": [ { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "null" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/tasks/series": { "get": { "operationId": "crm_tasks_series_list", "tags": [ "crm" ], "summary": "Every repeating-task series in the workspace", "description": "Every repeating-task series in the workspace.", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "active", "paused", "ended" ] } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/tasks/series/{seriesId}/occurrences": { "get": { "operationId": "crm_tasks_series_occurrences", "tags": [ "crm" ], "summary": "Every occurrence (task) of one series", "description": "Every occurrence (task) of one series.", "parameters": [ { "name": "seriesId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/batch": { "post": { "operationId": "crm_entries_createMany", "tags": [ "crm" ], "summary": "Create many entries", "description": "Create many CRM entries.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "maxItems": 200, "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Field-name -> value map. For `user` fields use one member userId or a userId array; preserve every assignee." }, "description": "Up to 200 field maps." } }, "required": [ "entries" ] }, "example": { "entries": [ { "Name": "Jane", "Email": "jane@example.com" }, { "Name": "Bob", "Email": "bob@example.com" } ] } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false }, "results": { "type": "array", "items": { "type": "object", "properties": { "entryId": { "type": "string" } }, "required": [ "entryId" ], "additionalProperties": false } }, "count": { "type": "number" } }, "required": [ "results", "count" ], "additionalProperties": false }, "example": { "results": [ { "entryId": "ent_lead99" }, { "entryId": "ent_lead100" } ], "count": 2 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "patch": { "operationId": "crm_entries_updateMany", "tags": [ "crm" ], "summary": "Update many entries", "description": "Update many CRM entries.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string", "description": "Object the entries belong to." }, "description": "Object the entries belong to." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "updates": { "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "entryId": { "type": "string" }, "id": { "type": "string" }, "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Field-name -> value map. For `user` fields use one member userId or a userId array; preserve every assignee." } }, "required": [ "data" ], "additionalProperties": false }, "description": "Per-entry partial updates (entryId or id + data)." } }, "required": [ "updates" ] }, "example": { "updates": [] } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false }, "results": { "type": "array", "items": { "type": "object", "properties": { "entryId": { "type": "string" }, "deleted": { "type": "boolean" } }, "required": [ "entryId" ], "additionalProperties": {} } }, "count": { "type": "number" } }, "required": [ "results", "count" ], "additionalProperties": false }, "example": { "results": [ { "entryId": "ent_lead99" }, { "entryId": "ent_lead100" } ], "count": 2 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/delete": { "post": { "operationId": "crm_entries_bulkDelete", "tags": [ "crm" ], "summary": "Bulk delete entries", "description": "Bulk delete CRM entries.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entryIds": { "maxItems": 200, "type": "array", "items": { "type": "string" } } }, "required": [ "entryIds" ] }, "example": { "entryIds": [] } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" } }, "required": [ "count" ], "additionalProperties": false }, "example": { "count": 3 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/{entryId}/fields/{fieldName}": { "get": { "operationId": "crm_cells_get", "tags": [ "crm" ], "summary": "Get cell", "description": "Get a CRM cell value.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "description": "Cell value. Enum=option string, tags=string array, user=one member userId or a userId array, relation=related entry id, boolean=true/false." }, "example": "Qualified" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "put": { "operationId": "crm_cells_set", "tags": [ "crm" ], "summary": "Set cell", "description": "Set a CRM cell value.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "description": "Cell value. Enum=option string, tags=string array, user=one member userId or a userId array, relation=related entry id, boolean=true/false." } }, "required": [ "value" ] }, "example": { "value": [ "user_kumar", "user_mark" ] } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "entryId": { "type": "string" }, "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false } }, "required": [ "entryId" ], "additionalProperties": false }, "example": { "entryId": "ent_lead99" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/cells/batch": { "post": { "operationId": "crm_cells_setMany", "tags": [ "crm" ], "summary": "Set many cells", "description": "Set many CRM cell values.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cells": { "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "objectName": { "type": "string" }, "entryId": { "type": "string" }, "fieldName": { "type": "string" }, "value": { "description": "Cell value. Enum=option string, tags=string array, user=one member userId or a userId array, relation=related entry id, boolean=true/false." } }, "required": [ "objectName", "entryId", "fieldName", "value" ], "additionalProperties": false } } }, "required": [ "cells" ] }, "example": { "cells": [] } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "entryId": { "type": "string" } }, "required": [ "entryId" ], "additionalProperties": false } }, "count": { "type": "number" } }, "required": [ "results", "count" ], "additionalProperties": false }, "example": { "results": [ { "entryId": "ent_lead99" }, { "entryId": "ent_lead100" } ], "count": 2 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/entries/{entryId}/fields/{fieldName}/append": { "post": { "operationId": "crm_cells_append", "tags": [ "crm" ], "summary": "Append cell", "description": "Append to a CRM cell.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "description": "Cell value. Enum=option string, tags=string array, user=one member userId or a userId array, relation=related entry id, boolean=true/false." } }, "required": [ "value" ] }, "example": { "value": "value" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "entryId": { "type": "string" }, "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false } }, "required": [ "entryId" ], "additionalProperties": false }, "example": { "entryId": "ent_lead99" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/query": { "post": { "operationId": "crm_query", "tags": [ "crm" ], "summary": "Query entries", "description": "Query CRM entries.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "withReferences": { "description": "Include bounded navigation references. Array reads return {data, references, referenceCoverage}; existing result envelopes keep their fields.", "type": "boolean" }, "objectName": { "type": "string" }, "dsl": { "description": "Query DSL. Bare equality only; use dslJson for $-operators.", "type": "object", "properties": { "filter": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "select": { "type": "array", "items": { "type": "string" } }, "sort": { "description": "e.g. -Score,Name (- = desc).", "type": "string" }, "limit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false }, "dslJson": { "description": "JSON string of the DSL when filters use operators like $gt/$in/$contains/$and/$or. Date fields and the system timestamps created_at/updated_at also accept $datePreset (\"today\", \"yesterday\", \"this_week\", \"last_week\", \"this_month\", \"last_month\", \"this_quarter\", \"last_quarter\", \"this_year\", \"last_year\"), and $inLast/$inNext rolling windows (a day count like 7, or {\"amount\":2,\"unit\":\"weeks\"} with unit days|weeks|months|quarters|years). Example: {\"filter\":{\"updated_at\":{\"$datePreset\":\"this_month\"}}}.", "type": "string" }, "assignedTo": { "description": "Personal scope: \"me\" (the signed-in member / the human behind an agent session), \"unassigned\", or a member userId or email. Adds one has_any / is_empty rule on the object's assignee user field; rows, totalCount, sums and analytics all follow it. Never saved onto the view.", "type": "string" }, "assigneeField": { "description": "Which `user` field \"assigned\" means. Default: the analytics owner role, else the task `Assignee`, else a user field named like owner/assignee, else the first user field.", "type": "string" } }, "required": [ "objectName" ] }, "example": { "objectName": "lead", "dslJson": "{\"filter\":{\"Status\":\"Qualified\",\"Score\":{\"$gt\":50}},\"sort\":\"-Score\",\"limit\":50}" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false } }, "required": [ "data", "references", "referenceCoverage" ], "additionalProperties": false } ], "description": "Entry rows. With dsl.select the rows are flat {_id, ...selectedFields} objects instead." }, "example": [ { "id": "ent_lead99", "objectId": "obj_lead01", "fields": { "Name": "Ada Lovelace", "Status": "Qualified", "Score": 85 }, "createdAt": 1765526400000, "updatedAt": 1765612800000, "updatedBy": "user:us_xyz789", "sortOrder": 0 } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/query/page": { "post": { "operationId": "crm_queryPage", "tags": [ "crm" ], "summary": "Scan CRM entries with a resumable cursor. Empty filtered pages can have more results", "description": "Scan CRM entries with a resumable cursor. Empty filtered pages can have more results.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "objectName": { "type": "string" }, "dsl": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "dslJson": { "type": "string" }, "assignedTo": { "description": "Personal scope: \"me\" (the signed-in member / the human behind an agent session), \"unassigned\", or a member userId or email. Adds one has_any / is_empty rule on the object's assignee user field; rows, totalCount, sums and analytics all follow it. Never saved onto the view.", "type": "string" }, "assigneeField": { "description": "Which `user` field \"assigned\" means. Default: the analytics owner role, else the task `Assignee`, else a user field named like owner/assignee, else the first user field.", "type": "string" }, "withReferences": { "description": "Include bounded navigation references. Array reads return {data, references, referenceCoverage}; existing result envelopes keep their fields.", "type": "boolean" }, "paginationOpts": { "type": "object", "properties": { "numItems": { "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "numItems", "cursor" ], "additionalProperties": false } }, "required": [ "objectName", "paginationOpts" ] }, "example": { "objectName": "string", "paginationOpts": {} } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/sql": { "post": { "operationId": "crm_sql", "tags": [ "crm" ], "summary": "SQL query", "description": "Run CRM SQL-compatible query.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "objectName": { "type": "string" }, "dsl": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "dslJson": { "type": "string" } }, "required": [ "objectName" ] }, "example": { "objectName": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "objectId": { "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Field-name -> cell value map." }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "updatedBy": { "type": "string" }, "sortOrder": { "type": "number" } }, "required": [ "id", "objectId", "fields", "createdAt", "updatedAt", "updatedBy", "sortOrder" ], "additionalProperties": false, "description": "A materialized CRM entry (row)." }, "description": "Entry rows. With dsl.select the rows are flat {_id, ...selectedFields} objects instead." }, "example": [ { "id": "ent_lead99", "objectId": "obj_lead01", "fields": { "Name": "Ada Lovelace", "Status": "Qualified", "Score": 85 }, "createdAt": 1765526400000, "updatedAt": 1765612800000, "updatedBy": "user:us_xyz789", "sortOrder": 0 } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/aggregate": { "post": { "operationId": "crm_aggregate", "tags": [ "crm" ], "summary": "Aggregate", "description": "Aggregate CRM entries.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "objectName": { "type": "string" }, "fieldName": { "type": "string", "description": "Field to bucket by." }, "sumField": { "description": "Number field to total per bucket (e.g. Amount grouped by Stage). Exact at any table size.", "type": "string" } }, "required": [ "objectName", "fieldName" ] }, "example": { "objectName": "string", "fieldName": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "count": { "type": "number" }, "sumNumber": { "type": "number" } }, "required": [ "key", "count" ], "additionalProperties": false } }, "example": [ { "key": "Stage:New", "count": 12, "sum": 48000 }, { "key": "Stage:Qualified", "count": 8, "sum": 64000 } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/search": { "get": { "operationId": "crm_search", "tags": [ "crm" ], "summary": "Search entries", "description": "Search CRM entries.", "parameters": [ { "name": "withReferences", "in": "query", "required": false, "schema": { "description": "Include bounded navigation references. Array reads return {data, references, referenceCoverage}; existing result envelopes keep their fields.", "type": "boolean" }, "description": "Include bounded navigation references. Array reads return {data, references, referenceCoverage}; existing result envelopes keep their fields." }, { "name": "text", "in": "query", "required": true, "schema": { "type": "string", "description": "Full-text query." }, "description": "Full-text query." }, { "name": "objectName", "in": "query", "required": false, "schema": { "description": "Omit to search org-wide.", "type": "string" }, "description": "Omit to search org-wide." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "_creationTime": { "type": "number" }, "objectId": { "type": "string" }, "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Field-name -> cell value map." }, "sortOrder": { "type": "number" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "updatedBy": { "type": "string" } }, "required": [ "_id", "_creationTime", "objectId", "data", "sortOrder", "createdAt", "updatedAt", "updatedBy" ], "additionalProperties": {} } }, { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "_creationTime": { "type": "number" }, "objectId": { "type": "string" }, "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Field-name -> cell value map." }, "sortOrder": { "type": "number" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "updatedBy": { "type": "string" } }, "required": [ "_id", "_creationTime", "objectId", "data", "sortOrder", "createdAt", "updatedAt", "updatedBy" ], "additionalProperties": {} } }, "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false } }, "required": [ "data", "references", "referenceCoverage" ], "additionalProperties": false } ] }, "example": [ { "_id": "ent_lead99", "_creationTime": 1765526400000, "objectId": "obj_lead01", "data": { "Name": "Acme Corp", "Status": "Qualified" }, "sortOrder": 0, "createdAt": 1765526400000, "updatedAt": 1765612800000, "updatedBy": "user:us_xyz789" } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/search/page": { "get": { "operationId": "crm_search_page", "tags": [ "crm" ], "summary": "Search bounded pages of readable CRM entries, optionally projecting cells. Always follow continueCursor until isDone", "description": "Search bounded pages of readable CRM entries, optionally projecting cells. Always follow continueCursor until isDone.", "parameters": [ { "name": "withReferences", "in": "query", "required": false, "schema": { "description": "Include bounded navigation references. Array reads return {data, references, referenceCoverage}; existing result envelopes keep their fields.", "type": "boolean" }, "description": "Include bounded navigation references. Array reads return {data, references, referenceCoverage}; existing result envelopes keep their fields." }, { "name": "text", "in": "query", "required": true, "schema": { "type": "string", "description": "Full-text query over readable entries." }, "description": "Full-text query over readable entries." }, { "name": "objectName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "schema": { "minItems": 1, "maxItems": 30, "type": "array", "items": { "type": "string", "minLength": 1 } } }, { "name": "selectionMode", "in": "query", "required": false, "schema": { "description": "Defaults to strict. Explicit modes require objectName and select. Compact recovers unknown selected names with bounded canonical columns and explicit selectionFallback metadata in the same response. Does not guess aliases.", "type": "string", "enum": [ "strict", "compact" ] }, "description": "Defaults to strict. Explicit modes require objectName and select. Compact recovers unknown selected names with bounded canonical columns and explicit selectionFallback metadata in the same response. Does not guess aliases." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "description": "Use the preceding continueCursor, with the same query and projection.", "type": "string" }, "description": "Use the preceding continueCursor, with the same query and projection." } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false }, "page": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "objectId": { "type": "string" }, "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Field-name -> cell value map." } }, "required": [ "_id", "objectId", "data" ], "additionalProperties": false } }, "isDone": { "type": "boolean" }, "continueCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "returnedCount": { "type": "number" }, "selectedFields": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "selectionFallback": { "description": "Present only when compact mode recovered unknown selected fields. selectedFields and row keys use actual canonical names; unresolved names are never fabricated as empty cells. Truncated values are previews, not complete cell values.", "type": "object", "properties": { "mode": { "type": "string", "const": "compact" }, "requestedFields": { "type": "array", "items": { "type": "string" } }, "unresolvedFields": { "type": "array", "items": { "type": "string" } }, "availableFields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "type" ], "additionalProperties": false } }, "availableFieldCount": { "type": "number" }, "schemaTruncated": { "type": "boolean" }, "omittedFieldCount": { "type": "number" }, "truncatedValues": { "type": "array", "items": { "type": "object", "properties": { "entryId": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } } }, "required": [ "entryId", "fields" ], "additionalProperties": false } } }, "required": [ "mode", "requestedFields", "unresolvedFields", "availableFields", "availableFieldCount", "schemaTruncated", "omittedFieldCount", "truncatedValues" ], "additionalProperties": false }, "completeness": { "type": "string", "const": "page" } }, "required": [ "page", "isDone", "continueCursor", "returnedCount", "selectedFields", "completeness" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/statuses": { "get": { "operationId": "crm_statuses_list", "tags": [ "crm" ], "summary": "List statuses", "description": "List CRM statuses.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "_creationTime": { "type": "number" }, "objectId": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "sortOrder": { "type": "number" }, "isDefault": { "type": "boolean" } }, "required": [ "_id", "_creationTime", "objectId", "name", "color", "sortOrder", "isDefault" ], "additionalProperties": {} } }, "example": [ { "_id": "sts_new01", "_creationTime": 1765526400000, "objectId": "obj_lead01", "name": "New", "color": "#94a3b8", "sortOrder": 100, "isDefault": true } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "put": { "operationId": "crm_statuses_set", "tags": [ "crm" ], "summary": "Set statuses", "description": "Set CRM statuses.", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "statuses": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "color": { "type": "string", "description": "Hex color." }, "sortOrder": { "type": "number" }, "isDefault": { "type": "boolean" } }, "required": [ "name", "color" ], "additionalProperties": false } } }, "required": [ "statuses" ] }, "example": { "statuses": [ { "name": "New", "color": "#94a3b8" }, { "name": "Working", "color": "#3b82f6" }, { "name": "Qualified", "color": "#22c55e", "isDefault": true } ] } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false }, "example": { "ok": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/batch": { "post": { "operationId": "crm_batch", "tags": [ "crm" ], "summary": "Batch operations", "description": "Apply a CRM batch.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "withReferences": { "description": "Include bounded navigation references. Array reads return {data, references, referenceCoverage}; existing result envelopes keep their fields.", "type": "boolean" }, "ops": { "maxItems": 200, "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "entries.create" }, "objectName": { "type": "string" }, "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Field-name -> value map. For `user` fields use one member userId or a userId array; preserve every assignee." } }, "required": [ "type", "objectName", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "entries.update" }, "entryId": { "type": "string" }, "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Field-name -> value map. For `user` fields use one member userId or a userId array; preserve every assignee." } }, "required": [ "type", "entryId", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "entries.delete" }, "entryId": { "type": "string" } }, "required": [ "type", "entryId" ], "additionalProperties": false } ], "description": "A single CRM batch/transaction operation." } }, "idempotencyKey": { "type": "string" } }, "required": [ "ops" ] }, "example": { "ops": [ { "type": "entries.create", "objectName": "people", "data": { "Name": "Jane" } } ], "idempotencyKey": "import-2026-06-01" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false }, "results": { "type": "array", "items": { "type": "object", "properties": { "entryId": { "type": "string" }, "deleted": { "type": "boolean" } }, "required": [ "entryId" ], "additionalProperties": {} } }, "count": { "type": "number" } }, "required": [ "results", "count" ], "additionalProperties": false }, "example": { "results": [ { "entryId": "ent_lead101" }, { "entryId": "ent_lead99", "deleted": true } ], "count": 2 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/transactions": { "post": { "operationId": "crm_transaction_begin", "tags": [ "crm" ], "summary": "Begin transaction", "description": "Begin a CRM transaction.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "txnId": { "type": "string" } }, "required": [ "txnId" ], "additionalProperties": false }, "example": { "txnId": "txn_abc01" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/transactions/{txnId}/operations": { "post": { "operationId": "crm_transaction_add", "tags": [ "crm" ], "summary": "Add operation", "description": "Add an operation to a CRM transaction.", "parameters": [ { "name": "txnId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "op": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "entries.create" }, "objectName": { "type": "string" }, "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Field-name -> value map. For `user` fields use one member userId or a userId array; preserve every assignee." } }, "required": [ "type", "objectName", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "entries.update" }, "entryId": { "type": "string" }, "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {}, "description": "Field-name -> value map. For `user` fields use one member userId or a userId array; preserve every assignee." } }, "required": [ "type", "entryId", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "entries.delete" }, "entryId": { "type": "string" } }, "required": [ "type", "entryId" ], "additionalProperties": false } ], "description": "A single CRM batch/transaction operation." } }, "required": [ "op" ] }, "example": { "op": { "type": "entries.update", "entryId": "ent_lead99", "data": { "Status": "Qualified" } } } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false }, "example": { "ok": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/transactions/{txnId}/commit": { "post": { "operationId": "crm_transaction_commit", "tags": [ "crm" ], "summary": "Commit transaction", "description": "Commit a CRM transaction.", "parameters": [ { "name": "txnId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "references": { "maxItems": 100, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-entry" }, "objectName": { "type": "string" }, "entryId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "entryId", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "crm-object" }, "objectName": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "objectName", "label", "href" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "campaign" }, "sequenceId": { "type": "string" }, "label": { "type": "string" }, "href": { "type": "string" }, "url": { "type": "string" }, "imageUrl": { "type": "string" }, "objectIcon": { "type": "string" } }, "required": [ "kind", "sequenceId", "label", "href" ], "additionalProperties": false } ] } }, "referenceCoverage": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" } }, "required": [ "returned", "available", "truncated" ], "additionalProperties": false }, "results": { "type": "array", "items": { "type": "object", "properties": { "entryId": { "type": "string" }, "deleted": { "type": "boolean" } }, "required": [ "entryId" ], "additionalProperties": {} } }, "count": { "type": "number" } }, "required": [ "results", "count" ], "additionalProperties": false }, "example": { "results": [ { "entryId": "ent_deal01" } ], "count": 1 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/transactions/{txnId}/abort": { "post": { "operationId": "crm_transaction_abort", "tags": [ "crm" ], "summary": "Abort transaction", "description": "Abort a CRM transaction.", "parameters": [ { "name": "txnId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false }, "example": { "ok": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/transactions/{txnId}": { "get": { "operationId": "crm_transaction_inspect", "tags": [ "crm" ], "summary": "Inspect transaction", "description": "Inspect a CRM transaction.", "parameters": [ { "name": "txnId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_id": { "type": "string" }, "_creationTime": { "type": "number" }, "status": { "type": "string", "enum": [ "open", "committed", "aborted" ] }, "ops": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "results": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "committedAt": { "type": "number" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "_id", "_creationTime", "status", "createdAt", "updatedAt" ], "additionalProperties": {} }, { "type": "null" } ] }, "example": { "_id": "txn_abc01", "_creationTime": 1765526400000, "status": "open", "ops": [ { "type": "entries.create", "objectName": "lead", "data": { "Name": "Beta Inc" } } ], "createdAt": 1765526400000, "updatedAt": 1765526400000 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/docs": { "get": { "operationId": "crm_docs_list", "tags": [ "crm" ], "summary": "List documents", "description": "List CRM documents.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "_creationTime": { "type": "number" }, "title": { "type": "string" }, "icon": { "type": "string" }, "coverImage": { "type": "string" }, "filePath": { "type": "string" }, "parentId": { "type": "string" }, "parentObjectId": { "type": "string" }, "entryId": { "type": "string" }, "sortOrder": { "type": "number" }, "isPublished": { "type": "boolean" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "_id", "_creationTime", "title", "filePath", "sortOrder", "isPublished", "createdAt", "updatedAt" ], "additionalProperties": {} } }, "example": [ { "_id": "doc_q2notes", "_creationTime": 1765526400000, "title": "Q2 Pipeline Notes", "filePath": "/docs/q2-pipeline.md", "sortOrder": 1765526400000, "isPublished": false, "createdAt": 1765526400000, "updatedAt": 1765612800000 } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "operationId": "crm_docs_create", "tags": [ "crm" ], "summary": "Create document", "description": "Create a CRM document.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "filePath": { "type": "string" }, "icon": { "type": "string" }, "coverImage": { "type": "string" }, "parentId": { "type": "string" }, "parentObjectName": { "type": "string" }, "entryId": { "type": "string" } }, "required": [ "title", "filePath" ] }, "example": { "title": "string", "filePath": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, "example": { "id": "doc_q2notes" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/docs/link": { "post": { "operationId": "crm_docs_link", "tags": [ "crm" ], "summary": "Link document", "description": "Link a CRM document.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filePath": { "type": "string" }, "objectName": { "type": "string" }, "entryId": { "type": "string" } }, "required": [ "filePath" ] }, "example": { "filePath": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false }, "example": { "ok": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/docs/{documentId}": { "delete": { "operationId": "crm_docs_delete", "tags": [ "crm" ], "summary": "Delete document", "description": "Delete a CRM document page; its workspace file stays and nested pages move up.", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "string", "description": "The id crm docs create returned." }, "description": "The id crm docs create returned." } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false }, "example": { "ok": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/actions": { "get": { "operationId": "crm_actions_list", "tags": [ "crm" ], "summary": "List actions", "description": "List CRM actions.", "parameters": [ { "name": "entryId", "in": "query", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "_creationTime": { "type": "number" }, "actionId": { "type": "string" }, "fieldId": { "type": "string" }, "entryId": { "type": "string" }, "objectId": { "type": "string" }, "runId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "completed", "failed" ] }, "startedAt": { "type": "number" }, "completedAt": { "type": "number" }, "result": { "type": "string" }, "error": { "type": "string" } }, "required": [ "_id", "_creationTime", "actionId", "fieldId", "entryId", "objectId", "status", "startedAt" ], "additionalProperties": {} } }, "example": [ { "_id": "arun_01", "_creationTime": 1765526400000, "actionId": "enrich_company", "fieldId": "fld_action01", "entryId": "ent_lead99", "objectId": "obj_lead01", "status": "completed", "startedAt": 1765526400000, "completedAt": 1765526460000, "result": "Enriched 4 fields" } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "post": { "operationId": "crm_actions_create", "tags": [ "crm" ], "summary": "Create or upsert an action button on a named action column (fieldName is the column header; a column can hold multiple buttons — reuse fieldName to add more)", "description": "Create or upsert an action button on a named action column (fieldName is the column header; a column can hold multiple buttons — reuse fieldName to add more).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "objectName": { "type": "string" }, "fieldName": { "type": "string" }, "actionId": { "type": "string" }, "label": { "type": "string" }, "variant": { "type": "string" }, "icon": { "type": "string" }, "confirmMessage": { "type": "string" }, "recipe": { "type": "array", "items": {} }, "script": { "type": "string" }, "scriptPath": { "type": "string" } }, "required": [ "objectName", "fieldName" ] }, "example": { "objectName": "string", "fieldName": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldId": { "type": "string" }, "actionId": { "type": "string" }, "fieldCreated": { "type": "boolean" } }, "required": [ "fieldId", "actionId", "fieldCreated" ], "additionalProperties": false }, "example": { "fieldId": "fld_actions", "actionId": "mark_won", "fieldCreated": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/actions/{actionId}": { "patch": { "operationId": "crm_actions_update", "tags": [ "crm" ], "summary": "Update an action button on a CRM field", "description": "Update an action button on a CRM field.", "parameters": [ { "name": "actionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "objectName": { "type": "string" }, "fieldName": { "type": "string" }, "label": { "type": "string" }, "variant": { "type": "string" }, "icon": { "type": "string" }, "confirmMessage": { "type": "string" }, "recipe": { "type": "array", "items": {} }, "script": { "type": "string" }, "scriptPath": { "type": "string" } }, "required": [ "objectName", "fieldName" ] }, "example": { "objectName": "string", "fieldName": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldId": { "type": "string" }, "actionId": { "type": "string" }, "fieldCreated": { "type": "boolean" } }, "required": [ "fieldId", "actionId", "fieldCreated" ], "additionalProperties": false }, "example": { "fieldId": "fld_actions", "actionId": "mark_won", "fieldCreated": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "delete": { "operationId": "crm_actions_delete", "tags": [ "crm" ], "summary": "Delete an action button from a CRM field", "description": "Delete an action button from a CRM field.", "parameters": [ { "name": "actionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "objectName": { "type": "string" }, "fieldName": { "type": "string" }, "fieldId": { "type": "string" }, "deleteFieldIfEmpty": { "type": "boolean" } }, "required": [ "objectName" ] }, "example": { "objectName": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "remaining": { "type": "number" }, "fieldDeleted": { "type": "boolean" } }, "required": [ "ok", "remaining", "fieldDeleted" ], "additionalProperties": false }, "example": { "ok": true, "remaining": 0, "fieldDeleted": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/actions/{actionId}/runs": { "post": { "operationId": "crm_actions_run", "tags": [ "crm" ], "summary": "Run action", "description": "Run a CRM action on one or more entries.", "parameters": [ { "name": "actionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "objectName": { "type": "string" }, "fieldId": { "type": "string" }, "entryIds": { "type": "array", "items": { "type": "string" } }, "prompts": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "required": [ "objectName", "fieldId", "entryIds" ] }, "example": { "objectName": "string", "fieldId": "string", "entryIds": [] } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "entryId": { "type": "string" }, "status": { "type": "string", "enum": [ "success", "error" ] }, "operations": { "type": "number" }, "error": { "type": "string" } }, "required": [ "entryId", "status" ], "additionalProperties": false } } }, "required": [ "results" ], "additionalProperties": false }, "example": { "results": [ { "entryId": "ent_lead99", "status": "success", "operations": 1 } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/members": { "get": { "operationId": "crm_members_list", "tags": [ "crm" ], "summary": "List members", "description": "List workspace members for CRM user fields.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "members": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tagline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "IANA zone, when the member set one." }, "presence": { "type": "string", "enum": [ "online", "away", "offline" ] }, "lastActiveAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "role": { "type": "string" }, "joinedAt": { "type": "number" } }, "required": [ "userId", "name", "email", "image", "tagline", "timezone", "presence", "lastActiveAt", "role", "joinedAt" ], "additionalProperties": false } }, "organizationId": { "type": "string" }, "organizationSlug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "organizationName": { "type": "string" } }, "required": [ "members", "organizationId", "organizationSlug", "organizationName" ], "additionalProperties": false }, "example": { "members": [ { "userId": "us_xyz789", "name": "Jane Doe", "email": "jane@acme.com", "image": null, "tagline": "Head of Ops", "timezone": "America/New_York", "presence": "online", "lastActiveAt": 1765612790000, "role": "ADMIN", "joinedAt": 1765440000000 } ], "organizationId": "org_abc123", "organizationSlug": "acme", "organizationName": "Acme" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/members/presence": { "get": { "operationId": "members_presence", "tags": [ "members" ], "summary": "Live presence (online / away / offline) for workspace members", "description": "Live presence (online / away / offline) for workspace members.", "parameters": [ { "name": "userIds", "in": "query", "required": false, "schema": { "description": "Comma-separated user ids; omit for every member.", "type": "string" }, "description": "Comma-separated user ids; omit for every member." } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "state": { "type": "string", "enum": [ "online", "away", "offline" ] }, "lastActiveAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "userId", "state", "lastActiveAt" ], "additionalProperties": false } }, "example": [ { "userId": "us_xyz789", "state": "online", "lastActiveAt": 1765612790000 }, { "userId": "us_abc123", "state": "offline", "lastActiveAt": null } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/members/{userId}": { "get": { "operationId": "members_get", "tags": [ "members" ], "summary": "A member's profile: name, email, tagline, role, timezone, presence, open task count", "description": "A member's profile: name, email, tagline, role, timezone, presence, open task count.", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tagline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "ADMIN", "MEMBER" ] }, "joinedAt": { "type": "number" }, "timezone": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "string" }, "source": { "type": "string", "enum": [ "auto", "manual", "agent" ] }, "updatedAt": { "type": "number" } }, "required": [ "value", "source", "updatedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "presence": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "online", "away", "offline" ] }, "lastActiveAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "state", "lastActiveAt" ], "additionalProperties": false }, "openTaskCount": { "type": "number", "description": "Capped at 500." }, "openTaskCountCapped": { "description": "True when openTaskCount stopped at its cap.", "type": "boolean" }, "commentCount": { "type": "number", "description": "Capped at 200." }, "changeCount": { "type": "number", "description": "Capped at 200." }, "lastContributionAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isSelf": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "tagline", "role", "joinedAt", "timezone", "presence", "openTaskCount", "commentCount", "changeCount", "lastContributionAt", "isSelf" ], "additionalProperties": false }, { "type": "null" } ] }, "example": { "userId": "us_xyz789", "name": "Jane Doe", "email": "jane@acme.com", "image": null, "tagline": "Head of Ops", "role": "ADMIN", "joinedAt": 1765440000000, "timezone": { "value": "America/New_York", "source": "manual", "updatedAt": 1765440000000 }, "presence": { "state": "online", "lastActiveAt": 1765612790000 }, "openTaskCount": 4, "commentCount": 31, "changeCount": 118, "lastContributionAt": 1765612800000, "isSelf": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/members/{userId}/activity": { "get": { "operationId": "members_activity", "tags": [ "members" ], "summary": "A member's recent comments and record changes across the CRM, newest first", "description": "A member's recent comments and record changes across the CRM, newest first.", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "kinds", "in": "query", "required": false, "schema": { "description": "Comma-separated subset of comments,changes.", "type": "string" }, "description": "Comma-separated subset of comments,changes." } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "comment" }, "id": { "type": "string" }, "entryId": { "type": "string" }, "objectName": { "type": "string" }, "entryLabel": { "type": "string" }, "body": { "type": "string" }, "parentCommentId": { "type": "string" }, "deleted": { "type": "boolean" }, "at": { "type": "number" } }, "required": [ "kind", "id", "entryId", "objectName", "entryLabel", "body", "deleted", "at" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "change" }, "id": { "type": "string" }, "entryId": { "type": "string" }, "objectName": { "type": "string" }, "entryLabel": { "type": "string" }, "changeKind": { "type": "string", "enum": [ "create", "update", "delete" ] }, "changes": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "before": {}, "after": {} }, "required": [ "fieldName" ], "additionalProperties": false } }, "at": { "type": "number" } }, "required": [ "kind", "id", "entryId", "objectName", "entryLabel", "changeKind", "changes", "at" ], "additionalProperties": {} } ] } }, "example": [ { "kind": "comment", "id": "cmt_01", "entryId": "ent_lead99", "objectName": "company", "entryLabel": "Ramp", "body": "Kickoff went well.", "deleted": false, "at": 1765612800000 }, { "kind": "change", "id": "hist_01", "entryId": "ent_lead99", "objectName": "company", "entryLabel": "Ramp", "changeKind": "update", "changes": [ { "fieldName": "Status", "before": "New", "after": "Qualified" } ], "at": 1765612700000 } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/members/{userId}/tasks": { "get": { "operationId": "members_tasks", "tags": [ "members" ], "summary": "Open tasks assigned to a member (plus ones completed today)", "description": "Open tasks assigned to a member (plus ones completed today).", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } }, { "name": "todayStartMs", "in": "query", "required": false, "schema": { "type": "number" } } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string", "description": "Same as name: the task's title field." }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "dueDateKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "done": { "type": "boolean" } }, "required": [ "id", "name", "title", "status", "dueDate", "dueDateKey", "done" ], "additionalProperties": false } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/me/profile": { "get": { "operationId": "me_profile_get", "tags": [ "members" ], "summary": "Your own member profile", "description": "Your own member profile.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tagline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "ADMIN", "MEMBER" ] }, "joinedAt": { "type": "number" }, "timezone": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "string" }, "source": { "type": "string", "enum": [ "auto", "manual", "agent" ] }, "updatedAt": { "type": "number" } }, "required": [ "value", "source", "updatedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "presence": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "online", "away", "offline" ] }, "lastActiveAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "state", "lastActiveAt" ], "additionalProperties": false }, "openTaskCount": { "type": "number", "description": "Capped at 500." }, "openTaskCountCapped": { "description": "True when openTaskCount stopped at its cap.", "type": "boolean" }, "commentCount": { "type": "number", "description": "Capped at 200." }, "changeCount": { "type": "number", "description": "Capped at 200." }, "lastContributionAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isSelf": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "tagline", "role", "joinedAt", "timezone", "presence", "openTaskCount", "commentCount", "changeCount", "lastContributionAt", "isSelf" ], "additionalProperties": false }, { "type": "null" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "patch": { "operationId": "me_profile_update", "tags": [ "members" ], "summary": "Update your name, tagline, avatar URL, or timezone", "description": "Update your name, tagline, avatar URL, or timezone.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "tagline": { "description": "Empty string clears.", "type": "string", "maxLength": 160 }, "imageUrl": { "description": "http(s) image URL; empty string clears the avatar.", "type": "string" }, "timezone": { "description": "IANA zone; null returns to browser detection.", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "example": { "tagline": "Head of Ops", "timezone": "America/New_York" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tagline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "ADMIN", "MEMBER" ] }, "joinedAt": { "type": "number" }, "timezone": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "string" }, "source": { "type": "string", "enum": [ "auto", "manual", "agent" ] }, "updatedAt": { "type": "number" } }, "required": [ "value", "source", "updatedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "presence": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "online", "away", "offline" ] }, "lastActiveAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "state", "lastActiveAt" ], "additionalProperties": false }, "openTaskCount": { "type": "number", "description": "Capped at 500." }, "openTaskCountCapped": { "description": "True when openTaskCount stopped at its cap.", "type": "boolean" }, "commentCount": { "type": "number", "description": "Capped at 200." }, "changeCount": { "type": "number", "description": "Capped at 200." }, "lastContributionAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isSelf": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "tagline", "role", "joinedAt", "timezone", "presence", "openTaskCount", "commentCount", "changeCount", "lastContributionAt", "isSelf" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/me/avatar/upload-url": { "post": { "operationId": "me_avatar_uploadUrl", "tags": [ "members" ], "summary": "Get a one-time URL to POST an avatar image to; then PUT /me/avatar with the returned storageId", "description": "Get a one-time URL to POST an avatar image to; then PUT /me/avatar with the returned storageId.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "string", "description": "One-time upload URL." } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/me/avatar": { "put": { "operationId": "me_avatar_set", "tags": [ "members" ], "summary": "Set your avatar from an uploaded storageId", "description": "Set your avatar from an uploaded storageId.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "storageId": { "type": "string", "description": "storageId returned by the upload POST." } }, "required": [ "storageId" ] }, "example": { "storageId": "kg2abc123def456" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "image": { "type": "string" } }, "required": [ "image" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } }, "delete": { "operationId": "me_avatar_clear", "tags": [ "members" ], "summary": "Remove your avatar", "description": "Remove your avatar.", "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/reports": { "post": { "operationId": "crm_reports_generate", "tags": [ "crm" ], "summary": "Generate report", "description": "Generate a CRM report.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "objectName": { "type": "string" }, "type": { "type": "string", "enum": [ "pie", "bar", "line", "table" ], "description": "Chart type for the generated report." }, "groupByField": { "type": "string" }, "metric": { "type": "string", "enum": [ "count", "sum", "avg", "min", "max" ], "description": "Aggregation metric. Defaults to `count`." }, "metricField": { "description": "Number field to sum/avg per bucket (e.g. Amount grouped by Stage). Defaults to the group field itself.", "type": "string" } }, "required": [ "objectName", "type", "groupByField" ] }, "example": { "objectName": "string", "type": "pie", "groupByField": "string" } } } }, "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "spec": { "type": "object", "properties": { "objectName": { "type": "string" }, "type": { "type": "string", "enum": [ "pie", "bar", "line", "table" ], "description": "Chart type for the generated report." }, "groupByField": { "type": "string" }, "metric": { "type": "string", "enum": [ "count", "sum", "avg", "min", "max" ], "description": "Aggregation metric. Defaults to `count`." }, "metricField": { "type": "string" } }, "required": [ "objectName", "type", "groupByField", "metric" ], "additionalProperties": false }, "buckets": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "number" }, "sum": { "type": "number" }, "avg": { "type": "number" } }, "required": [ "key", "label", "count" ], "additionalProperties": false } }, "totalCount": { "type": "number" }, "truncated": { "description": "True when a bounded row scan (not the exact pre-aggregates) produced the sums.", "type": "boolean" } }, "required": [ "spec", "buckets", "totalCount" ], "additionalProperties": false }, "example": { "spec": { "objectName": "lead", "type": "bar", "groupByField": "Status", "metric": "count" }, "buckets": [ { "key": "New", "label": "New", "count": 12, "sum": 0, "avg": 0 }, { "key": "Qualified", "label": "Qualified", "count": 8, "sum": 640, "avg": 80 } ], "totalCount": 20 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/crm/objects/{objectName}/analytics": { "get": { "operationId": "crm_analytics_get", "tags": [ "crm" ], "summary": "Read an object's analytics dashboard: panels, field roles, the strip's collapsed flag, the named view's own dashboard (if any), and the fields panels may bucket on (synthetic $createdAt / $location last)", "description": "Read an object's analytics dashboard: panels, field roles, the strip's collapsed flag, the named view's own dashboard (if any), and the fields panels may bucket on (synthetic $createdAt / $location last).", "parameters": [ { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "viewName", "in": "query", "required": false, "schema": { "description": "Also return this saved view's own dashboard (viewAnalytics) when it has one.", "type": "string" }, "description": "Also return this saved view's own dashboard (viewAnalytics) when it has one." } ], "security": [ { "DenchApiKey": [] }, { "AgentSession": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "objectName": { "type": "string" }, "analytics": { "anyOf": [ { "type": "object", "properties": { "panels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable id (template panels use `tpl: