{ "openapi": "3.0.0", "info": { "title": "MarketSizer Enrich API", "description": "Company enrichment, market intelligence, and vendor analytics API. Two servers: api.marketsizer.io (enrichment, discovery, CRM) and app.marketsizer.io (v1/v2 market data, vendor stats, signals).", "version": "2.0.0", "contact": { "name": "MarketSizer", "url": "https://app.marketsizer.io" } }, "servers": [ { "url": "https://api.marketsizer.io", "description": "Production" }, { "url": "https://app.marketsizer.io", "description": "Web App (v1/v2 endpoints)" } ], "tags": [ { "name": "Enrichment", "description": "Company data enrichment" }, { "name": "Discovery", "description": "Company discovery and filtering" }, { "name": "Competitive Intel", "description": "Vendor competitive intelligence" }, { "name": "Credits", "description": "Credit management" }, { "name": "Users", "description": "User and token management" }, { "name": "CRM", "description": "CRM OAuth and integrations" }, { "name": "Health", "description": "Health checks" }, { "name": "Vendor Data (v2)", "description": "Vendor statistics, trends, and tech stack data (public, no auth required)" }, { "name": "Market Data (v2)", "description": "Market statistics by region, country, and vendor type (public, no auth required)" }, { "name": "Integration API (v1)", "description": "Token-authenticated enrichment for external integrations" }, { "name": "Signals (v1)", "description": "Sales signals and intent data per domain" } ], "paths": { "/enrich-MySQL": { "post": { "description": "Enrichment endpoint — submits Enrich MySQL. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postEnrichMySQL", "summary": "Submit Enrich MySQL", "tags": [ "Enrichment" ] } }, "/ext-solas": { "post": { "description": "Enrichment endpoint — submits Ext Solas. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "schema": { "type": "string" } }, { "name": "criteria", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postExtSolas", "summary": "Submit Ext Solas", "tags": [ "Enrichment" ] } }, "/subscription": { "post": { "description": "Enrichment endpoint — submits Subscription. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "schema": { "type": "string" } }, { "name": "criteria", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postSubscription", "summary": "Submit Subscription", "tags": [ "Enrichment" ] } }, "/company": { "post": { "description": "Enrichment endpoint — submits Company. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "schema": { "type": "string" } }, { "name": "criteria", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postCompany", "summary": "Submit Company", "tags": [ "Enrichment" ] } }, "/company-history": { "post": { "description": "Enrichment endpoint — submits Company History. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "schema": { "type": "string" } }, { "name": "criteria", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postCompanyHistory", "summary": "Submit Company History", "tags": [ "Enrichment" ] } }, "/vendor-offering": { "post": { "description": "Vendor Data (v2) endpoint — submits Vendor Offering. Auth: public (no token required).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "schema": { "type": "string" } }, { "name": "criteria", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postVendorOffering", "summary": "Submit Vendor Offering", "tags": [ "Vendor Data (v2)" ], "security": [] } }, "/vendor": { "post": { "description": "Competitive Intel endpoint — submits Vendor. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "schema": { "type": "string" } }, { "name": "criteria", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postVendor", "summary": "Submit Vendor", "tags": [ "Competitive Intel" ] } }, "/vendor-competitor": { "post": { "description": "Competitive Intel endpoint — submits Vendor Competitor. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "schema": { "type": "string" } }, { "name": "criteria", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postVendorCompetitor", "summary": "Submit Vendor Competitor", "tags": [ "Competitive Intel" ] } }, "/vendor-competitive-intel": { "post": { "description": "Competitive Intel endpoint — submits Vendor Competitive Intel. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "x-marketsizer-user-id", "in": "header", "schema": { "type": "string" } }, { "name": "x-marketsizer-org-id", "in": "header", "schema": { "type": "string" } }, { "name": "vendor", "in": "query", "schema": { "type": "string" } }, { "name": "orgVendor", "in": "query", "schema": { "type": "string" } }, { "name": "vendorOfferingId", "in": "query", "schema": { "type": "string" } }, { "name": "orgVendorOfferingId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postVendorCompetitiveIntel", "summary": "Submit Vendor Competitive Intel", "tags": [ "Competitive Intel" ] } }, "/vendor-market-profile": { "get": { "description": "Competitive Intel endpoint — retrieves Vendor Market Profile. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "offeringIds", "in": "query", "schema": { "type": "string" } }, { "name": "vendor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getVendorMarketProfile", "summary": "Retrieve Vendor Market Profile", "tags": [ "Competitive Intel" ] }, "post": { "description": "Competitive Intel endpoint — submits Vendor Market Profile. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "offeringIds", "in": "query", "schema": { "type": "string" } }, { "name": "vendor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "offeringIds": { "example": "any" }, "vendor": { "example": "any" } } } } } }, "operationId": "postVendorMarketProfile", "summary": "Submit Vendor Market Profile", "tags": [ "Competitive Intel" ] } }, "/vendor-customer-shape": { "get": { "description": "Competitive Intel endpoint — retrieves Vendor Customer Shape. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "offeringId", "in": "query", "schema": { "type": "string" } }, { "name": "vendor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getVendorCustomerShape", "summary": "Retrieve Vendor Customer Shape", "tags": [ "Competitive Intel" ] }, "post": { "description": "Competitive Intel endpoint — submits Vendor Customer Shape. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "offeringId", "in": "query", "schema": { "type": "string" } }, { "name": "vendor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "offeringId": { "example": "any" }, "vendor": { "example": "any" } } } } } }, "operationId": "postVendorCustomerShape", "summary": "Submit Vendor Customer Shape", "tags": [ "Competitive Intel" ] } }, "/vendor-competitive-trend": { "post": { "description": "Competitive Intel endpoint — submits Vendor Competitive Trend. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "quarters", "in": "query", "schema": { "type": "string" } }, { "name": "vendor", "in": "query", "schema": { "type": "string" } }, { "name": "competitor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postVendorCompetitiveTrend", "summary": "Submit Vendor Competitive Trend", "tags": [ "Competitive Intel" ] } }, "/vendor-competitive-intel-bulk": { "post": { "description": "Competitive Intel endpoint — submits Vendor Competitive Intel Bulk. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "x-marketsizer-user-id", "in": "header", "schema": { "type": "string" } }, { "name": "x-marketsizer-org-id", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postVendorCompetitiveIntelBulk", "summary": "Submit Vendor Competitive Intel Bulk", "tags": [ "Competitive Intel" ] } }, "/vendor-competitive-recommendations": { "post": { "description": "Competitive Intel endpoint — submits Vendor Competitive Recommendations. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "x-marketsizer-user-id", "in": "header", "schema": { "type": "string" } }, { "name": "x-marketsizer-org-id", "in": "header", "schema": { "type": "string" } }, { "name": "vendor", "in": "query", "schema": { "type": "string" } }, { "name": "types", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "vendorOfferingId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postVendorCompetitiveRecommendations", "summary": "Submit Vendor Competitive Recommendations", "tags": [ "Competitive Intel" ] } }, "/store-usage": { "post": { "description": "Credits endpoint — submits Store Usage. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Token": { "example": "any" }, "Total_Hit": { "example": "any" }, "Usage_Type": { "example": "any" }, "Criteria": { "example": "any" }, "Executed_Time": { "example": "any" }, "Ip_Address": { "example": "any" }, "Description": { "example": "any" } } } } } }, "operationId": "postStoreUsage", "summary": "Submit Store Usage", "tags": [ "Credits" ] } }, "/usertoken-MySQL": { "post": { "description": "Users endpoint — submits Usertoken MySQL. Auth: public (no token required).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postUsertokenMySQL", "summary": "Submit Usertoken MySQL", "tags": [ "Users" ], "security": [] } }, "/usertoken": { "post": { "description": "Users endpoint — submits Usertoken. Auth: public (no token required).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "x-provision-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "example": "any" }, "password": { "example": "any" }, "planName": { "example": "any" }, "zohodatacenter": { "example": "any" }, "appname": { "example": "any" }, "refreshtoken": { "example": "any" }, "portalid": { "example": "any" } } } } } }, "operationId": "postUsertoken", "summary": "Submit Usertoken", "tags": [ "Users" ], "security": [] } }, "/usertoken-solas": { "post": { "description": "Users endpoint — submits Usertoken Solas. Auth: public (no token required).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "example": "any" }, "password": { "example": "any" }, "planName": { "example": "any" }, "zohodatacenter": { "example": "any" }, "appname": { "example": "any" }, "refreshtoken": { "example": "any" }, "portalid": { "example": "any" }, "solasAccountId": { "example": "any" } } } } } }, "operationId": "postUsertokenSolas", "summary": "Submit Usertoken Solas", "tags": [ "Users" ], "security": [] } }, "/getPlanDetails": { "post": { "description": "Credits endpoint — submits GetPlanDetails. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "example": "any" }, "email": { "example": "any" }, "portalid": { "example": "any" } } } } } }, "operationId": "postGetplandetails", "summary": "Submit GetPlanDetails", "tags": [ "Credits" ] } }, "/getPlanDetails-solas": { "post": { "description": "Credits endpoint — submits GetPlanDetails Solas. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "example": "any" }, "email": { "example": "any" }, "portalid": { "example": "any" } } } } } }, "operationId": "postGetplandetailsSolas", "summary": "Submit GetPlanDetails Solas", "tags": [ "Credits" ] } }, "/getPlanDetails-MySQL": { "post": { "description": "Credits endpoint — submits GetPlanDetails MySQL. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postGetplandetailsMySQL", "summary": "Submit GetPlanDetails MySQL", "tags": [ "Credits" ] } }, "/addCredit-MySQL": { "post": { "description": "Credits endpoint — submits AddCredit MySQL. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postAddcreditMySQL", "summary": "Submit AddCredit MySQL", "tags": [ "Credits" ] } }, "/addCredit": { "post": { "description": "Credits endpoint — submits AddCredit. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "adminpassword", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "example": "any" }, "token": { "example": "any" }, "creditPurchase": { "example": "any" }, "type": { "example": "any" }, "newPlan": { "example": "any" } } } } } }, "operationId": "postAddcredit", "summary": "Submit AddCredit", "tags": [ "Credits" ] } }, "/addCreditToExtSolasUser": { "post": { "description": "Credits endpoint — submits AddCreditToExtSolasUser. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "adminpassword", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "example": "any" }, "token": { "example": "any" }, "creditPurchase": { "example": "any" }, "type": { "example": "any" }, "newPlan": { "example": "any" } } } } } }, "operationId": "postAddcredittoextsolasuser", "summary": "Submit AddCreditToExtSolasUser", "tags": [ "Credits" ] } }, "/deductCredit-MySQL": { "post": { "description": "Credits endpoint — submits DeductCredit MySQL. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postDeductcreditMySQL", "summary": "Submit DeductCredit MySQL", "tags": [ "Credits" ] } }, "/deductCredit": { "post": { "description": "Credits endpoint — submits DeductCredit. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "adminpassword", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "example": "any" }, "creditPurchase": { "example": "any" } } } } } }, "operationId": "postDeductcredit", "summary": "Submit DeductCredit", "tags": [ "Credits" ] } }, "/updatestatus-MySQL": { "post": { "description": "Users endpoint — submits Updatestatus MySQL. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postUpdatestatusMySQL", "summary": "Submit Updatestatus MySQL", "tags": [ "Users" ] } }, "/updatestatus": { "post": { "description": "Users endpoint — submits Updatestatus. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "adminpassword", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "example": "any" }, "status": { "example": "any" } } } } } }, "operationId": "postUpdatestatus", "summary": "Submit Updatestatus", "tags": [ "Users" ] } }, "/updateUserInfo-MySQL": { "post": { "description": "Users endpoint — submits UpdateUserInfo MySQL. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postUpdateuserinfoMySQL", "summary": "Submit UpdateUserInfo MySQL", "tags": [ "Users" ] } }, "/updateUserInfo": { "post": { "description": "Users endpoint — submits UpdateUserInfo. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "adminpassword", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "example": "any" }, "columnName": { "example": "any" }, "columnValue": { "example": "any" } } } } } }, "operationId": "postUpdateuserinfo", "summary": "Submit UpdateUserInfo", "tags": [ "Users" ] } }, "/updateSolasUserInfo": { "post": { "description": "Users endpoint — submits UpdateSolasUserInfo. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "adminpassword", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "example": "any" }, "columnName": { "example": "any" }, "columnValue": { "example": "any" } } } } } }, "operationId": "postUpdatesolasuserinfo", "summary": "Submit UpdateSolasUserInfo", "tags": [ "Users" ] } }, "/user-delete": { "delete": { "description": "Users endpoint — deletes User Delete. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "adminpassword", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "example": "any" }, "token": { "example": "any" } } } } } }, "operationId": "deleteUserDelete", "summary": "Delete User Delete", "tags": [ "Users" ] } }, "/solas-user-delete": { "delete": { "description": "Users endpoint — deletes Solas User Delete. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "adminpassword", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "example": "any" }, "token": { "example": "any" } } } } } }, "operationId": "deleteSolasUserDelete", "summary": "Delete Solas User Delete", "tags": [ "Users" ] } }, "/auth/callback": { "get": { "description": "CRM endpoint — retrieves Auth Callback. Auth: public (no token required).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "410": { "description": "Gone" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getAuthCallback", "summary": "Retrieve Auth Callback", "tags": [ "CRM" ], "security": [] } }, "/test/accont": { "post": { "description": "Enrichment endpoint — submits Test Accont. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "req", "in": "query", "schema": { "type": "string" } }, { "name": "hs_email_domain", "in": "query", "schema": { "type": "string" } }, { "name": "domain", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postTestAccont", "summary": "Submit Test Accont", "tags": [ "Enrichment" ] } }, "/zoho/auth": { "get": { "description": "CRM endpoint — retrieves Zoho Auth. Auth: public (no token required).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "datacenter", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getZohoAuth", "summary": "Retrieve Zoho Auth", "tags": [ "CRM" ], "security": [] } }, "/zoho/callback": { "get": { "description": "CRM endpoint — retrieves Zoho Callback. Auth: public (no token required).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "location", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "410": { "description": "Gone" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getZohoCallback", "summary": "Retrieve Zoho Callback", "tags": [ "CRM" ], "security": [] } }, "/freshwork/callback": { "get": { "description": "CRM endpoint — retrieves Freshwork Callback. Auth: public (no token required).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "apiKey", "in": "query", "schema": { "type": "string" } }, { "name": "domain", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "410": { "description": "Gone" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getFreshworkCallback", "summary": "Retrieve Freshwork Callback", "tags": [ "CRM" ], "security": [] } }, "/salesforces-auth": { "get": { "description": "CRM endpoint — retrieves Salesforces Auth. Auth: public (no token required).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getSalesforcesAuth", "summary": "Retrieve Salesforces Auth", "tags": [ "CRM" ], "security": [] } }, "/salesforces/callback": { "get": { "description": "CRM endpoint — retrieves Salesforces Callback. Auth: public (no token required).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "410": { "description": "Gone" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getSalesforcesCallback", "summary": "Retrieve Salesforces Callback", "tags": [ "CRM" ], "security": [] } }, "/salesforces-enrich": { "post": { "description": "CRM endpoint — submits Salesforces Enrich. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "recordId", "in": "query", "schema": { "type": "string" } }, { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "website", "in": "query", "schema": { "type": "string" } }, { "name": "instanceUrl", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postSalesforcesEnrich", "summary": "Submit Salesforces Enrich", "tags": [ "CRM" ] } }, "/": { "get": { "description": "Health endpoint — retrieves the API root. Auth: public (no token required).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "get", "summary": "Retrieve root", "tags": [ "Health" ], "security": [] } }, "/discovery": { "post": { "description": "Discovery endpoint — submits Discovery. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "target_competitors": { "example": "any" }, "win_rates": { "example": "any" }, "target_competitor_offering_ids": { "example": "any" }, "filters": { "example": "any" }, "vendor_slug": { "example": "any" }, "allowed_competitor_types": { "example": "any" }, "org_id": { "example": "any" }, "sort": { "example": "any" }, "page": { "example": "any" }, "limit": { "example": "any" } } } } } }, "operationId": "postDiscovery", "summary": "Submit Discovery", "tags": [ "Discovery" ] } }, "/discovery/batch-scores": { "post": { "description": "Discovery endpoint — submits Discovery Batch Scores. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "org_id": { "example": "any" }, "target_competitors": { "example": "any" }, "win_rates": { "example": "any" }, "domains": { "example": "any" }, "vendor_slug": { "example": "any" }, "target_competitor_offering_ids": { "example": "any" }, "allowed_competitor_types": { "example": "any" } } } } } }, "operationId": "postDiscoveryBatchScores", "summary": "Submit Discovery Batch Scores", "tags": [ "Discovery" ] } }, "/discovery/counts": { "post": { "description": "Discovery endpoint — submits Discovery Counts. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "target_competitors": { "example": "any" }, "filters": { "example": "any" } } } } } }, "operationId": "postDiscoveryCounts", "summary": "Submit Discovery Counts", "tags": [ "Discovery" ] } }, "/discovery/warm-cache": { "post": { "description": "Discovery endpoint — submits Discovery Warm Cache. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "competitor_sets": { "example": "any" } } } } } }, "operationId": "postDiscoveryWarmCache", "summary": "Submit Discovery Warm Cache", "tags": [ "Discovery" ] } }, "/discovery/warm-filters": { "post": { "description": "Discovery endpoint — submits Discovery Warm Filters. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "504": { "description": "Gateway Timeout" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "org_id": { "example": "any" } } } } } }, "operationId": "postDiscoveryWarmFilters", "summary": "Submit Discovery Warm Filters", "tags": [ "Discovery" ] } }, "/discovery/health": { "get": { "description": "Discovery endpoint — retrieves Discovery Health. Auth: public (no token required).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryHealth", "summary": "Retrieve Discovery Health", "tags": [ "Discovery" ], "security": [] } }, "/discovery/vendor-types": { "get": { "description": "Discovery endpoint — retrieves Discovery Vendor Types. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryVendorTypes", "summary": "Retrieve Discovery Vendor Types", "tags": [ "Discovery" ] } }, "/discovery/facet-counts": { "get": { "description": "Discovery endpoint — retrieves Discovery Facet Counts. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "org_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryFacetCounts", "summary": "Retrieve Discovery Facet Counts", "tags": [ "Discovery" ] } }, "/discovery/admin/refresh-facet-counts": { "post": { "description": "Discovery endpoint — submits Discovery Admin Refresh Facet Counts. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postDiscoveryAdminRefreshFacetCounts", "summary": "Submit Discovery Admin Refresh Facet Counts", "tags": [ "Discovery" ] } }, "/discovery/admin/refresh-facet-counts/status": { "get": { "description": "Discovery endpoint — retrieves Discovery Admin Refresh Facet Counts Status. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryAdminRefreshFacetCountsStatus", "summary": "Retrieve Discovery Admin Refresh Facet Counts Status", "tags": [ "Discovery" ] } }, "/discovery/vendor-types-tree": { "get": { "description": "Discovery endpoint — retrieves Discovery Vendor Types Tree. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryVendorTypesTree", "summary": "Retrieve Discovery Vendor Types Tree", "tags": [ "Discovery" ] } }, "/discovery/search": { "post": { "description": "Discovery endpoint — submits Discovery Search. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "country": { "example": "any" }, "employee_tier": { "example": "any" }, "icp_tier": { "example": "any" }, "traffic_tier": { "example": "any" }, "vendor": { "example": "any" }, "has_intent": { "example": "any" }, "min_score": { "example": "any" }, "limit": { "example": "any" }, "offset": { "example": "any" } } } } } }, "operationId": "postDiscoverySearch", "summary": "Submit Discovery Search", "tags": [ "Discovery" ] } }, "/discovery/admin/null-rates": { "get": { "description": "Discovery endpoint — retrieves Discovery Admin Null Rates. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "nocache", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryAdminNullRates", "summary": "Retrieve Discovery Admin Null Rates", "tags": [ "Discovery" ] } }, "/discovery/admin/flat-distribution": { "get": { "description": "Discovery endpoint — retrieves Discovery Admin Flat Distribution. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "dimension", "in": "query", "schema": { "type": "string" } }, { "name": "nocache", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryAdminFlatDistribution", "summary": "Retrieve Discovery Admin Flat Distribution", "tags": [ "Discovery" ] } }, "/geo/countries": { "get": { "description": "Enrichment endpoint — retrieves Geo Countries. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "nocache", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getGeoCountries", "summary": "Retrieve Geo Countries", "tags": [ "Enrichment" ] } }, "/discovery/admin/drift-check": { "post": { "description": "Discovery endpoint — submits Discovery Admin Drift Check. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postDiscoveryAdminDriftCheck", "summary": "Submit Discovery Admin Drift Check", "tags": [ "Discovery" ] } }, "/discovery/admin/create-indexes": { "post": { "description": "Discovery endpoint — submits Discovery Admin Create Indexes. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postDiscoveryAdminCreateIndexes", "summary": "Submit Discovery Admin Create Indexes", "tags": [ "Discovery" ] } }, "/discovery/admin/check-indexes": { "get": { "description": "Discovery endpoint — retrieves Discovery Admin Check Indexes. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryAdminCheckIndexes", "summary": "Retrieve Discovery Admin Check Indexes", "tags": [ "Discovery" ] } }, "/discovery/admin/compute-single": { "post": { "description": "Discovery endpoint — submits Discovery Admin Compute Single. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "competitors": { "example": "any" } } } } } }, "operationId": "postDiscoveryAdminComputeSingle", "summary": "Submit Discovery Admin Compute Single", "tags": [ "Discovery" ] } }, "/discovery/admin/create-counts-tables": { "post": { "description": "Discovery endpoint — submits Discovery Admin Create Counts Tables. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postDiscoveryAdminCreateCountsTables", "summary": "Submit Discovery Admin Create Counts Tables", "tags": [ "Discovery" ] } }, "/discovery/admin/recompute-counts": { "post": { "description": "Discovery endpoint — submits Discovery Admin Recompute Counts. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "competitor_sets": { "example": "any" } } } } } }, "operationId": "postDiscoveryAdminRecomputeCounts", "summary": "Submit Discovery Admin Recompute Counts", "tags": [ "Discovery" ] } }, "/discovery/admin/counts-status": { "get": { "description": "Discovery endpoint — retrieves Discovery Admin Counts Status. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryAdminCountsStatus", "summary": "Retrieve Discovery Admin Counts Status", "tags": [ "Discovery" ] } }, "/discovery/webhook/icp-changed": { "post": { "description": "Discovery endpoint — submits Discovery Webhook Icp Changed. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "competitors": { "example": "any" }, "org_id": { "example": "any" }, "vendor_slug": { "example": "any" } } } } } }, "operationId": "postDiscoveryWebhookIcpChanged", "summary": "Submit Discovery Webhook Icp Changed", "tags": [ "Discovery" ] } }, "/discovery/admin/compute-individuals": { "post": { "description": "Discovery endpoint — submits Discovery Admin Compute Individuals. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "example": "any" } } } } } }, "operationId": "postDiscoveryAdminComputeIndividuals", "summary": "Submit Discovery Admin Compute Individuals", "tags": [ "Discovery" ] } }, "/discovery/admin/individual-status": { "get": { "description": "Discovery endpoint — retrieves Discovery Admin Individual Status. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryAdminIndividualStatus", "summary": "Retrieve Discovery Admin Individual Status", "tags": [ "Discovery" ] } }, "/discovery/admin/list-competitors": { "get": { "description": "Discovery endpoint — retrieves Discovery Admin List Competitors. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryAdminListCompetitors", "summary": "Retrieve Discovery Admin List Competitors", "tags": [ "Discovery" ] } }, "/search-knowledge-graph": { "get": { "description": "Enrichment endpoint — retrieves Search Knowledge Graph. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "top", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getSearchKnowledgeGraph", "summary": "Retrieve Search Knowledge Graph", "tags": [ "Enrichment" ] } }, "/brand-dashboard": { "post": { "description": "Enrichment endpoint — submits Brand Dashboard. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bqTableName": { "example": "any" } } } } } }, "operationId": "postBrandDashboard", "summary": "Submit Brand Dashboard", "tags": [ "Enrichment" ] } }, "/_ah/warmup": { "get": { "description": "Health endpoint — retrieves Ah Warmup. Auth: public (no token required).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getAhWarmup", "summary": "Retrieve Ah Warmup", "tags": [ "Health" ], "security": [] } }, "/smart-campaign-domains": { "post": { "description": "Enrichment endpoint — submits Smart Campaign Domains. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "example": "any" }, "limit": { "example": "any" }, "domains": { "example": "any" }, "meta": { "example": "any" } } } } } }, "operationId": "postSmartCampaignDomains", "summary": "Submit Smart Campaign Domains", "tags": [ "Enrichment" ] } }, "/vendor-offerings/list": { "post": { "description": "Vendor Data (v2) endpoint — submits Vendor Offerings List. Auth: public (no token required).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "active_only": { "example": "any" }, "vendor_id": { "example": "any" }, "vendor_type": { "example": "any" }, "search": { "example": "any" }, "limit": { "example": "any" } } } } } }, "operationId": "postVendorOfferingsList", "summary": "Submit Vendor Offerings List", "tags": [ "Vendor Data (v2)" ], "security": [] } }, "/vendor-offerings/{id}": { "get": { "description": "Vendor Data (v2) endpoint — retrieves Vendor Offerings By id. Auth: public (no token required).", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getVendorOfferingsById", "summary": "Retrieve Vendor Offerings By id", "tags": [ "Vendor Data (v2)" ], "security": [] } }, "/vendor/list": { "post": { "description": "Competitive Intel endpoint — submits Vendor List. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "search": { "example": "any" }, "limit": { "example": "any" } } } } } }, "operationId": "postVendorList", "summary": "Submit Vendor List", "tags": [ "Competitive Intel" ] } }, "/company-data/batch": { "post": { "description": "Enrichment endpoint — submits Company Data Batch. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domains": { "example": "any" } } } } } }, "operationId": "postCompanyDataBatch", "summary": "Submit Company Data Batch", "tags": [ "Enrichment" ] } }, "/subscription-arrs": { "post": { "description": "Enrichment endpoint — submits Subscription Arrs. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domains": { "example": "any" } } } } } }, "operationId": "postSubscriptionArrs", "summary": "Submit Subscription Arrs", "tags": [ "Enrichment" ] } }, "/discovery/warm": { "post": { "description": "Discovery endpoint — submits Discovery Warm. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postDiscoveryWarm", "summary": "Submit Discovery Warm", "tags": [ "Discovery" ] } }, "/discovery/cache/purge": { "post": { "description": "Discovery endpoint — submits Discovery Cache Purge. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postDiscoveryCachePurge", "summary": "Submit Discovery Cache Purge", "tags": [ "Discovery" ] } }, "/discovery/warm-status": { "get": { "description": "Discovery endpoint — retrieves Discovery Warm Status. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryWarmStatus", "summary": "Retrieve Discovery Warm Status", "tags": [ "Discovery" ] } }, "/etl/heartbeat": { "post": { "description": "Health endpoint — submits Etl Heartbeat. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postEtlHeartbeat", "summary": "Submit Etl Heartbeat", "tags": [ "Health" ] } }, "/etl/status": { "get": { "description": "Health endpoint — retrieves Etl Status. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getEtlStatus", "summary": "Retrieve Etl Status", "tags": [ "Health" ] } }, "/discovery/benchmark": { "get": { "description": "Discovery endpoint — retrieves Discovery Benchmark. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryBenchmark", "summary": "Retrieve Discovery Benchmark", "tags": [ "Discovery" ] } }, "/canonical-benchmark": { "get": { "description": "Enrichment endpoint — retrieves Canonical Benchmark. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "vendor", "in": "query", "schema": { "type": "string" } }, { "name": "competitor", "in": "query", "schema": { "type": "string" } }, { "name": "vendor_type", "in": "query", "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getCanonicalBenchmark", "summary": "Retrieve Canonical Benchmark", "tags": [ "Enrichment" ] } }, "/canonical-benchmark-matrix": { "get": { "description": "Enrichment endpoint — retrieves Canonical Benchmark Matrix. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "vendor_type", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getCanonicalBenchmarkMatrix", "summary": "Retrieve Canonical Benchmark Matrix", "tags": [ "Enrichment" ] } }, "/discovery/sync-status": { "get": { "description": "Discovery endpoint — retrieves Discovery Sync Status. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoverySyncStatus", "summary": "Retrieve Discovery Sync Status", "tags": [ "Discovery" ] } }, "/discovery/sync-org-configs": { "post": { "description": "Discovery endpoint — submits Discovery Sync Org Configs. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postDiscoverySyncOrgConfigs", "summary": "Submit Discovery Sync Org Configs", "tags": [ "Discovery" ] } }, "/discovery/sync-org": { "post": { "description": "Discovery endpoint — submits Discovery Sync Org. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "org_id": { "example": "any" } } } } } }, "operationId": "postDiscoverySyncOrg", "summary": "Submit Discovery Sync Org", "tags": [ "Discovery" ] } }, "/discovery/org-status": { "get": { "description": "Discovery endpoint — retrieves Discovery Org Status. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "org_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryOrgStatus", "summary": "Retrieve Discovery Org Status", "tags": [ "Discovery" ] } }, "/internal/post-refresh-hook": { "post": { "description": "Health endpoint — submits Internal Post Refresh Hook. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postInternalPostRefreshHook", "summary": "Submit Internal Post Refresh Hook", "tags": [ "Health" ] } }, "/internal/ledger-watermark": { "post": { "description": "Health endpoint — submits Internal Ledger Watermark. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postInternalLedgerWatermark", "summary": "Submit Internal Ledger Watermark", "tags": [ "Health" ] } }, "/customer-intel": { "post": { "description": "Discovery endpoint — submits Customer Intel. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "example": "any" }, "vendor_name": { "example": "any" }, "filters": { "example": "any" }, "sort": { "example": "any" }, "limit": { "example": "any" }, "page": { "example": "any" }, "vendor_offering_id": { "example": "any" } } } } } }, "operationId": "postCustomerIntel", "summary": "Submit Customer Intel", "tags": [ "Discovery" ] } }, "/customer-intel/warm": { "post": { "description": "Discovery endpoint — submits Customer Intel Warm. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "postCustomerIntelWarm", "summary": "Submit Customer Intel Warm", "tags": [ "Discovery" ] } }, "/customer-intel/events": { "get": { "description": "Discovery endpoint — retrieves Customer Intel Events. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "vendor_name", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "icp_tier", "in": "query", "schema": { "type": "string" } }, { "name": "event_type", "in": "query", "schema": { "type": "string" } }, { "name": "vendor_offering_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getCustomerIntelEvents", "summary": "Retrieve Customer Intel Events", "tags": [ "Discovery" ] } }, "/customer-intel/health": { "post": { "description": "Discovery endpoint — submits Customer Intel Health. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "vendor_name": { "example": "any" }, "filters": { "example": "any" }, "limit": { "example": "any" }, "page": { "example": "any" }, "sort": { "example": "any" }, "sort_direction": { "example": "any" }, "vendor_offering_id": { "example": "any" } } } } } }, "operationId": "postCustomerIntelHealth", "summary": "Submit Customer Intel Health", "tags": [ "Discovery" ] } }, "/customer-intel/signal-summary": { "get": { "description": "Discovery endpoint — retrieves Customer Intel Signal Summary. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "vendor_name", "in": "query", "schema": { "type": "string" } }, { "name": "vendor_offering_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getCustomerIntelSignalSummary", "summary": "Retrieve Customer Intel Signal Summary", "tags": [ "Discovery" ] } }, "/markets/summary": { "get": { "description": "Market Data (v2) endpoint — retrieves Markets Summary. Auth: public (no token required).", "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getMarketsSummary", "summary": "Retrieve Markets Summary", "tags": [ "Market Data (v2)" ], "security": [] } }, "/api/composio/health": { "get": { "description": "Enrichment endpoint — retrieves Api Composio Health. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getApiComposioHealth", "summary": "Retrieve Api Composio Health", "tags": [ "Enrichment" ] } }, "/api/composio/tools": { "get": { "description": "Enrichment endpoint — retrieves Api Composio Tools. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "toolkit", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getApiComposioTools", "summary": "Retrieve Api Composio Tools", "tags": [ "Enrichment" ] } }, "/api/composio/tools/{slug}/schema": { "get": { "description": "Enrichment endpoint — retrieves Api Composio Tools By slug Schema. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getApiComposioToolsBySlugSchema", "summary": "Retrieve Api Composio Tools By slug Schema", "tags": [ "Enrichment" ] } }, "/api/composio/connect": { "post": { "description": "Enrichment endpoint — submits Api Composio Connect. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "org_id": { "example": "any" }, "toolkit": { "example": "any" }, "callback_url": { "example": "any" }, "fields": { "example": "any" } } } } } }, "operationId": "postApiComposioConnect", "summary": "Submit Api Composio Connect", "tags": [ "Enrichment" ] } }, "/api/composio/connections": { "get": { "description": "Enrichment endpoint — retrieves Api Composio Connections. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "org_id", "in": "query", "schema": { "type": "string" } }, { "name": "statuses", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getApiComposioConnections", "summary": "Retrieve Api Composio Connections", "tags": [ "Enrichment" ] } }, "/api/composio/connections/{id}": { "get": { "description": "Enrichment endpoint — retrieves Api Composio Connections By id. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getApiComposioConnectionsById", "summary": "Retrieve Api Composio Connections By id", "tags": [ "Enrichment" ] }, "delete": { "description": "Enrichment endpoint — deletes Api Composio Connections By id. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "deleteApiComposioConnectionsById", "summary": "Delete Api Composio Connections By id", "tags": [ "Enrichment" ] } }, "/api/composio/execute": { "post": { "description": "Enrichment endpoint — submits Api Composio Execute. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "org_id": { "example": "any" }, "tool": { "example": "any" }, "arguments": { "example": "any" } } } } } }, "operationId": "postApiComposioExecute", "summary": "Submit Api Composio Execute", "tags": [ "Enrichment" ] } }, "/api/composio/auth-configs": { "post": { "description": "Enrichment endpoint — submits Api Composio Auth Configs. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "toolkit": { "example": "any" }, "scheme": { "example": "any" } } } } } }, "operationId": "postApiComposioAuthConfigs", "summary": "Submit Api Composio Auth Configs", "tags": [ "Enrichment" ] }, "get": { "description": "Enrichment endpoint — retrieves Api Composio Auth Configs. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getApiComposioAuthConfigs", "summary": "Retrieve Api Composio Auth Configs", "tags": [ "Enrichment" ] } }, "/api/composio/toolkits/{slug}/auth-fields": { "get": { "description": "Enrichment endpoint — retrieves Api Composio Toolkits By slug Auth Fields. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getApiComposioToolkitsBySlugAuthFields", "summary": "Retrieve Api Composio Toolkits By slug Auth Fields", "tags": [ "Enrichment" ] } }, "/api/composio/custom-toolkits": { "post": { "description": "Enrichment endpoint — submits Api Composio Custom Toolkits. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "example": "any" }, "name": { "example": "any" }, "app_url": { "example": "any" }, "auth_schemes": { "example": "any" }, "logo_file": { "example": "any" } } } } } }, "operationId": "postApiComposioCustomToolkits", "summary": "Submit Api Composio Custom Toolkits", "tags": [ "Enrichment" ] } }, "/api/composio/custom-toolkits/{slug}/sync": { "post": { "description": "Enrichment endpoint — submits Api Composio Custom Toolkits By slug Sync. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connected_account_id": { "example": "any" } } } } } }, "operationId": "postApiComposioCustomToolkitsBySlugSync", "summary": "Submit Api Composio Custom Toolkits By slug Sync", "tags": [ "Enrichment" ] } }, "/version": { "get": { "description": "Enrichment endpoint — retrieves Version. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getVersion", "summary": "Retrieve Version", "tags": [ "Enrichment" ] } }, "/api/composio/session/health": { "get": { "description": "Enrichment endpoint — retrieves Api Composio Session Health. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getApiComposioSessionHealth", "summary": "Retrieve Api Composio Session Health", "tags": [ "Enrichment" ] } }, "/api/composio/session/tools": { "get": { "description": "Enrichment endpoint — retrieves Api Composio Session Tools. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "org_id", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "toolkits", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getApiComposioSessionTools", "summary": "Retrieve Api Composio Session Tools", "tags": [ "Enrichment" ] } }, "/api/composio/session/tools/{slug}/schema": { "get": { "description": "Enrichment endpoint — retrieves Api Composio Session Tools By slug Schema. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "org_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getApiComposioSessionToolsBySlugSchema", "summary": "Retrieve Api Composio Session Tools By slug Schema", "tags": [ "Enrichment" ] } }, "/api/composio/session/connect": { "post": { "description": "Enrichment endpoint — submits Api Composio Session Connect. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "org_id": { "example": "any" }, "toolkit": { "example": "any" } } } } } }, "operationId": "postApiComposioSessionConnect", "summary": "Submit Api Composio Session Connect", "tags": [ "Enrichment" ] } }, "/api/composio/session/execute": { "post": { "description": "Enrichment endpoint — submits Api Composio Session Execute. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "org_id": { "example": "any" }, "tool": { "example": "any" }, "arguments": { "example": "any" } } } } } }, "operationId": "postApiComposioSessionExecute", "summary": "Submit Api Composio Session Execute", "tags": [ "Enrichment" ] } }, "/api/composio/session/route-execute": { "post": { "description": "Enrichment endpoint — submits Api Composio Session Route Execute. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "org_id": { "example": "any" }, "intent": { "example": "any" }, "toolkits": { "example": "any" }, "arguments": { "example": "any" } } } } } }, "operationId": "postApiComposioSessionRouteExecute", "summary": "Submit Api Composio Session Route Execute", "tags": [ "Enrichment" ] } }, "/api/composio/session/route-plan": { "post": { "description": "Enrichment endpoint — submits Api Composio Session Route Plan. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "422": { "description": "Unprocessable Entity" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "org_id": { "example": "any" }, "intent": { "example": "any" }, "toolkits": { "example": "any" }, "arguments": { "example": "any" }, "force_llm": { "example": "any" }, "strict_template": { "example": "any" } } } } } }, "operationId": "postApiComposioSessionRoutePlan", "summary": "Submit Api Composio Session Route Plan", "tags": [ "Enrichment" ] } }, "/api/composio/session/route-exec": { "post": { "description": "Enrichment endpoint — submits Api Composio Session Route Exec. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "409": { "description": "Conflict" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "plan_token": { "example": "any" } } } } } }, "operationId": "postApiComposioSessionRouteExec", "summary": "Submit Api Composio Session Route Exec", "tags": [ "Enrichment" ] } }, "/api/composio/session/import-connection": { "post": { "description": "Enrichment endpoint — submits Api Composio Session Import Connection. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "org_id": { "example": "any" }, "auth_config_id": { "example": "any" }, "scheme": { "example": "any" }, "credentials": { "example": "any" } } } } } }, "operationId": "postApiComposioSessionImportConnection", "summary": "Submit Api Composio Session Import Connection", "tags": [ "Enrichment" ] } }, "/api/composio/session/crm-summary": { "get": { "description": "Enrichment endpoint — retrieves Api Composio Session Crm Summary. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "org_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getApiComposioSessionCrmSummary", "summary": "Retrieve Api Composio Session Crm Summary", "tags": [ "Enrichment" ] } }, "/discovery/v2/competitors": { "get": { "description": "Vendor Data (v2) endpoint — retrieves Discovery v2 Competitors. Auth: public (no token required).", "parameters": [ { "name": "vendors", "in": "query", "schema": { "type": "string" } }, { "name": "country", "in": "query", "schema": { "type": "string" } }, { "name": "intent", "in": "query", "schema": { "type": "string" } }, { "name": "lifecycle", "in": "query", "schema": { "type": "string" } }, { "name": "recency_days", "in": "query", "schema": { "type": "string" } }, { "name": "icp_tier", "in": "query", "schema": { "type": "string" } }, { "name": "size", "in": "query", "schema": { "type": "string" } }, { "name": "x-org-id", "in": "header", "schema": { "type": "string" } }, { "name": "org_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryV2Competitors", "summary": "Retrieve Discovery v2 Competitors", "tags": [ "Vendor Data (v2)" ], "security": [] } }, "/discovery/v2/facet-counts": { "get": { "description": "Vendor Data (v2) endpoint — retrieves Discovery v2 Facet Counts. Auth: public (no token required).", "parameters": [ { "name": "vendors", "in": "query", "schema": { "type": "string" } }, { "name": "country", "in": "query", "schema": { "type": "string" } }, { "name": "x-org-id", "in": "header", "schema": { "type": "string" } }, { "name": "org_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryV2FacetCounts", "summary": "Retrieve Discovery v2 Facet Counts", "tags": [ "Vendor Data (v2)" ], "security": [] } }, "/discovery/v2/refresh-status": { "get": { "description": "Vendor Data (v2) endpoint — retrieves Discovery v2 Refresh Status. Auth: public (no token required).", "parameters": [ { "name": "x-org-id", "in": "header", "schema": { "type": "string" } }, { "name": "org_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getDiscoveryV2RefreshStatus", "summary": "Retrieve Discovery v2 Refresh Status", "tags": [ "Vendor Data (v2)" ], "security": [] } }, "/hubspot/status": { "get": { "description": "CRM endpoint — retrieves Hubspot Status. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "mskey", "in": "header", "schema": { "type": "string" } }, { "name": "MsKey", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getHubspotStatus", "summary": "Retrieve Hubspot Status", "tags": [ "CRM" ] } }, "/hubspot/check": { "post": { "description": "CRM endpoint — submits Hubspot Check. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "example": "any" } } } } } }, "operationId": "postHubspotCheck", "summary": "Submit Hubspot Check", "tags": [ "CRM" ] } }, "/hubspot/push": { "post": { "description": "CRM endpoint — submits Hubspot Push. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "example": "any" }, "companyData": { "example": "any" }, "operation": { "example": "any" } } } } } }, "operationId": "postHubspotPush", "summary": "Submit Hubspot Push", "tags": [ "CRM" ] } }, "/hubspot/enrich": { "post": { "description": "CRM endpoint — submits Hubspot Enrich. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "mskey", "in": "header", "schema": { "type": "string" } }, { "name": "MsKey", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "example": "any" }, "objectType": { "example": "any" }, "objectId": { "example": "any" } } } } } }, "operationId": "postHubspotEnrich", "summary": "Submit Hubspot Enrich", "tags": [ "CRM" ] } }, "/hubspot/workflow-enrich": { "post": { "description": "CRM endpoint — submits Hubspot Workflow Enrich. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-hubspot-signature-v3", "in": "header", "schema": { "type": "string" } }, { "name": "x-hubspot-request-timestamp", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "portalId": { "example": "any" }, "portal_id": { "example": "any" }, "hubId": { "example": "any" }, "objectType": { "example": "any" }, "object_type": { "example": "any" }, "subscriptionType": { "example": "any" }, "objectId": { "example": "any" }, "object_id": { "example": "any" }, "vid": { "example": "any" }, "companyId": { "example": "any" }, "properties": { "example": "any" }, "propertyValues": { "example": "any" } } } } } }, "operationId": "postHubspotWorkflowEnrich", "summary": "Submit Hubspot Workflow Enrich", "tags": [ "CRM" ] } }, "/zoho/status": { "get": { "description": "CRM endpoint — retrieves Zoho Status. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "mskey", "in": "header", "schema": { "type": "string" } }, { "name": "MsKey", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getZohoStatus", "summary": "Retrieve Zoho Status", "tags": [ "CRM" ] } }, "/zoho/check": { "post": { "description": "CRM endpoint — submits Zoho Check. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "example": "any" } } } } } }, "operationId": "postZohoCheck", "summary": "Submit Zoho Check", "tags": [ "CRM" ] } }, "/zoho/push": { "post": { "description": "CRM endpoint — submits Zoho Push. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "example": "any" }, "companyData": { "example": "any" }, "operation": { "example": "any" } } } } } }, "operationId": "postZohoPush", "summary": "Submit Zoho Push", "tags": [ "CRM" ] } }, "/zoho/enrich": { "post": { "description": "CRM endpoint — submits Zoho Enrich. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "mskey", "in": "header", "schema": { "type": "string" } }, { "name": "MsKey", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "example": "any" }, "accountId": { "example": "any" } } } } } }, "operationId": "postZohoEnrich", "summary": "Submit Zoho Enrich", "tags": [ "CRM" ] } }, "/hubspot/check-contact": { "post": { "description": "CRM endpoint — submits Hubspot Check Contact. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "example": "any" } } } } } }, "operationId": "postHubspotCheckContact", "summary": "Submit Hubspot Check Contact", "tags": [ "CRM" ] } }, "/hubspot/push-contact": { "post": { "description": "CRM endpoint — submits Hubspot Push Contact. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "example": "any" }, "last_name": { "example": "any" }, "work_email": { "example": "any" }, "personal_email": { "example": "any" }, "job_title": { "example": "any" }, "mobile_phone": { "example": "any" }, "company_name": { "example": "any" }, "linkedin_url": { "example": "any" } } } } } }, "operationId": "postHubspotPushContact", "summary": "Submit Hubspot Push Contact", "tags": [ "CRM" ] } }, "/zoho/check-contact": { "post": { "description": "CRM endpoint — submits Zoho Check Contact. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "example": "any" } } } } } }, "operationId": "postZohoCheckContact", "summary": "Submit Zoho Check Contact", "tags": [ "CRM" ] } }, "/zoho/push-contact": { "post": { "description": "CRM endpoint — submits Zoho Push Contact. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "example": "any" }, "last_name": { "example": "any" }, "work_email": { "example": "any" }, "personal_email": { "example": "any" }, "job_title": { "example": "any" }, "mobile_phone": { "example": "any" }, "company_name": { "example": "any" } } } } } }, "operationId": "postZohoPushContact", "summary": "Submit Zoho Push Contact", "tags": [ "CRM" ] } }, "/salesforce/status": { "get": { "description": "CRM endpoint — retrieves Salesforce Status. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getSalesforceStatus", "summary": "Retrieve Salesforce Status", "tags": [ "CRM" ] } }, "/freshsales/status": { "get": { "description": "CRM endpoint — retrieves Freshsales Status. Auth: requires a Bearer user token (see /usertoken).", "responses": { "200": { "description": "OK" }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getFreshsalesStatus", "summary": "Retrieve Freshsales Status", "tags": [ "CRM" ] } }, "/connections": { "get": { "description": "CRM endpoint — retrieves Connections. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "mskey", "in": "header", "schema": { "type": "string" } }, { "name": "MsKey", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getConnections", "summary": "Retrieve Connections", "tags": [ "CRM" ] } }, "/connections-by-org": { "get": { "description": "CRM endpoint — retrieves Connections By Org. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-clerk-org-id", "in": "header", "schema": { "type": "string" } }, { "name": "org_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "operationId": "getConnectionsByOrg", "summary": "Retrieve Connections By Org", "tags": [ "CRM" ] } }, "/disconnect": { "post": { "description": "Enrichment endpoint — submits Disconnect. Auth: requires a Bearer user token (see /usertoken).", "parameters": [ { "name": "x-clerk-org-id", "in": "header", "schema": { "type": "string" } }, { "name": "mskey", "in": "header", "schema": { "type": "string" } }, { "name": "MsKey", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized — missing or invalid Bearer token.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Unexpected error (RFC 9457 Problem Details).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "req": { "example": "any" } } } } } }, "operationId": "postDisconnect", "summary": "Submit Disconnect", "tags": [ "Enrichment" ] } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "User token obtained from /usertoken endpoint" } }, "schemas": { "ProblemDetails": { "type": "object", "description": "RFC 9457 Problem Details error object.", "properties": { "type": { "type": "string", "format": "uri", "description": "A URI reference identifying the problem type.", "example": "about:blank" }, "title": { "type": "string", "description": "Short, human-readable summary of the problem type.", "example": "Unauthorized" }, "status": { "type": "integer", "description": "HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Human-readable explanation specific to this occurrence." }, "instance": { "type": "string", "format": "uri", "description": "URI reference identifying the specific occurrence." } }, "required": [ "title", "status" ] } } }, "security": [ { "BearerAuth": [] } ] }