openapi: "3.1.0" info: title: "GTM Clarity API" version: "1.0.0" description: "Source-of-truth OpenAPI 3.1 description for /api/v1." servers: - url: "https://app.gtmclarity.ai/api/v1" description: "Production" - url: "https://api.gtmclarity.ai/v1" description: "Reserved — not yet live (#141)" tags: - name: "Customers" description: "Customer registry and widget configuration." - name: "Conversations" description: "Conversation and message reads." - name: "Identities" description: "Resolved identity reads." - name: "Webhooks" description: "Outbound webhook endpoint management." - name: "Webhook Events" description: "Outbound event payload contracts." - name: "Conversions" description: "Conversion ledger reads." - name: "Resolutions" description: "Resolution ledger reads." - name: "Usage" description: "Billing usage summaries." - name: "API Keys" description: "Programmatic API key management." paths: "/customers": get: operationId: "listCustomers" summary: "List customers" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Customers" security: - bearerAuth: [] parameters: - name: "limit" in: "query" required: false schema: default: 20 type: "integer" minimum: 1 maximum: 100 - name: "starting_after" in: "query" required: false schema: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/CustomerListResponse" "400": description: "Invalid request body, query, or pagination parameters." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" post: operationId: "createCustomer" summary: "Create customer" description: "Requires Bearer gtmc_ authentication with write tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Customers" security: - bearerAuth: [] parameters: - name: "Idempotency-Key" in: "header" required: false description: "Optional replay key for idempotent POST requests." schema: type: "string" minLength: 1 maxLength: 255 requestBody: required: true content: "application/json": schema: "$ref": "#/components/schemas/CustomerCreateRequest" responses: "201": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/Customer" "400": description: "Invalid request body, query, or pagination parameters." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "409": description: "Idempotency key conflict." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/customers/{id}": get: operationId: "getCustomer" summary: "Get customer" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Customers" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/Customer" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" patch: operationId: "updateCustomer" summary: "Update customer" description: "Requires Bearer gtmc_ authentication with write tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Customers" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 requestBody: required: true content: "application/json": schema: "$ref": "#/components/schemas/CustomerPatchRequest" responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/Customer" "400": description: "Invalid request body, query, or pagination parameters." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" delete: operationId: "deleteCustomer" summary: "Delete customer" description: "Requires Bearer gtmc_ authentication with admin tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Customers" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/DeletedResponse" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/customers/{id}/widget-config": get: operationId: "getWidgetConfig" summary: "Get widget config" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Customers" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/WidgetConfig" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" patch: operationId: "updateWidgetConfig" summary: "Update widget config" description: "Requires Bearer gtmc_ authentication with write tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Customers" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 requestBody: required: true content: "application/json": schema: "$ref": "#/components/schemas/WidgetConfigPatchRequest" responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/WidgetConfig" "400": description: "Invalid request body, query, or pagination parameters." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/customers/{id}/conversations": get: operationId: "listConversations" summary: "List conversations" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Conversations" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 - name: "limit" in: "query" required: false schema: default: 20 type: "integer" minimum: 1 maximum: 100 - name: "starting_after" in: "query" required: false schema: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 - name: "status" in: "query" required: false schema: type: "string" enum: - "open" - "ai_active" - "human_active" - "closed" - "converted" - name: "converted" in: "query" required: false schema: type: "string" enum: - "true" - "false" - name: "started_after" in: "query" required: false schema: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ConversationListResponse" "400": description: "Invalid request body, query, or pagination parameters." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/customers/{id}/conversations/{conversationId}": get: operationId: "getConversation" summary: "Get conversation" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Conversations" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 - name: "conversationId" in: "path" required: true description: "Conversation id." schema: type: "integer" minimum: 1 responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/Conversation" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/customers/{id}/conversations/{conversationId}/messages": get: operationId: "listMessages" summary: "List conversation messages" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Conversations" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 - name: "conversationId" in: "path" required: true description: "Conversation id." schema: type: "integer" minimum: 1 - name: "limit" in: "query" required: false schema: default: 50 type: "integer" minimum: 1 maximum: 100 - name: "starting_after" in: "query" required: false schema: default: 0 type: "integer" minimum: 0 maximum: 9007199254740991 - name: "include_system" in: "query" required: false schema: type: "string" enum: - "true" - "false" responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/MessageListResponse" "400": description: "Invalid request body, query, or pagination parameters." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/customers/{id}/identities": get: operationId: "listIdentities" summary: "List identity resolutions" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Identities" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 - name: "limit" in: "query" required: false schema: default: 20 type: "integer" minimum: 1 maximum: 100 - name: "starting_after" in: "query" required: false schema: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 - name: "include_payload" in: "query" required: false schema: default: "false" type: "string" enum: - "true" - "false" responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/IdentityListResponse" "400": description: "Invalid request body, query, or pagination parameters." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/customers/{id}/webhook-endpoints": get: operationId: "listWebhookEndpoints" summary: "List webhook endpoints" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Webhooks" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/WebhookEndpointListResponse" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" post: operationId: "createWebhookEndpoint" summary: "Create webhook endpoint" description: "Requires Bearer gtmc_ authentication with write tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Webhooks" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 requestBody: required: true content: "application/json": schema: "$ref": "#/components/schemas/WebhookEndpointCreateRequest" responses: "201": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/WebhookEndpointCreateResponse" "400": description: "Invalid request body, query, or pagination parameters." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/customers/{id}/webhook-endpoints/{endpointId}": get: operationId: "getWebhookEndpoint" summary: "Get webhook endpoint" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Webhooks" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 - name: "endpointId" in: "path" required: true description: "Webhook endpoint id." schema: type: "integer" minimum: 1 responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/WebhookEndpoint" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" patch: operationId: "updateWebhookEndpoint" summary: "Update webhook endpoint" description: "Requires Bearer gtmc_ authentication with write tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Webhooks" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 - name: "endpointId" in: "path" required: true description: "Webhook endpoint id." schema: type: "integer" minimum: 1 requestBody: required: true content: "application/json": schema: "$ref": "#/components/schemas/WebhookEndpointPatchRequest" responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/WebhookEndpoint" "400": description: "Invalid request body, query, or pagination parameters." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" delete: operationId: "deleteWebhookEndpoint" summary: "Delete webhook endpoint" description: "Requires Bearer gtmc_ authentication with admin tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Webhooks" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 - name: "endpointId" in: "path" required: true description: "Webhook endpoint id." schema: type: "integer" minimum: 1 responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/DeletedResponse" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/customers/{id}/webhook-endpoints/{endpointId}/deliveries": get: operationId: "listWebhookDeliveries" summary: "List webhook deliveries" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Webhooks" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 - name: "endpointId" in: "path" required: true description: "Webhook endpoint id." schema: type: "integer" minimum: 1 - name: "limit" in: "query" required: false schema: type: "integer" minimum: 1 maximum: 100 default: 20 - name: "cursor" in: "query" required: false schema: type: "integer" minimum: 1 responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/WebhookDeliveryListResponse" "400": description: "Invalid request body, query, or pagination parameters." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/customers/{id}/webhook-endpoints/{endpointId}/rotate-secret": post: operationId: "rotateWebhookSecret" summary: "Rotate webhook secret" description: "Requires Bearer gtmc_ authentication with write tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Webhooks" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Customer id." schema: type: "integer" minimum: 1 - name: "endpointId" in: "path" required: true description: "Webhook endpoint id." schema: type: "integer" minimum: 1 responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/RotatedSecretResponse" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/conversions": get: operationId: "listConversions" summary: "List conversions" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Conversions" security: - bearerAuth: [] parameters: - name: "limit" in: "query" required: false schema: default: 20 type: "integer" minimum: 1 maximum: 100 - name: "starting_after" in: "query" required: false schema: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 - name: "customer_id" in: "query" required: false schema: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 - name: "created_after" in: "query" required: false schema: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - name: "billed" in: "query" required: false schema: type: "string" enum: - "true" - "false" - name: "type" in: "query" required: false schema: type: "string" enum: - "booked_meeting" - "qualified_lead" - "sale" - "resolved_ticket" - "custom" - "captured_contact" - "qualified_meeting" responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ConversionListResponse" "400": description: "Invalid request body, query, or pagination parameters." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/conversions/{id}": get: operationId: "getConversion" summary: "Get conversion" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Conversions" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Ledger event id." schema: type: "integer" minimum: 1 responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/Conversion" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/resolutions": get: operationId: "listResolutions" summary: "List resolutions" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Resolutions" security: - bearerAuth: [] parameters: - name: "limit" in: "query" required: false schema: default: 20 type: "integer" minimum: 1 maximum: 100 - name: "starting_after" in: "query" required: false schema: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 - name: "customer_id" in: "query" required: false schema: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 - name: "created_after" in: "query" required: false schema: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - name: "billed" in: "query" required: false schema: type: "string" enum: - "true" - "false" responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ResolutionListResponse" "400": description: "Invalid request body, query, or pagination parameters." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/resolutions/{id}": get: operationId: "getResolution" summary: "Get resolution" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Resolutions" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "Ledger event id." schema: type: "integer" minimum: 1 responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/Resolution" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/usage": get: operationId: "getUsage" summary: "Get account usage" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Usage" security: - bearerAuth: [] responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/AccountUsage" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/usage/timeseries": get: operationId: "getUsageTimeseries" summary: "Get usage timeseries" description: "Requires Bearer gtmc_ authentication with read tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "Usage" security: - bearerAuth: [] parameters: - name: "bucket" in: "query" required: false schema: default: "day" type: "string" enum: - "day" - "week" - name: "from" in: "query" required: false schema: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - name: "to" in: "query" required: false schema: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/UsageTimeseries" "400": description: "Invalid request body, query, or pagination parameters." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/keys": get: operationId: "listApiKeys" summary: "List API keys" description: "Requires Bearer gtmc_ authentication with admin tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "API Keys" security: - bearerAuth: [] responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ApiKeyListResponse" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" post: operationId: "createApiKey" summary: "Create API key" description: "Requires Bearer gtmc_ authentication with admin tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "API Keys" security: - bearerAuth: [] requestBody: required: true content: "application/json": schema: "$ref": "#/components/schemas/ApiKeyCreateRequest" responses: "201": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ApiKeyCreateResponse" "400": description: "Invalid request body, query, or pagination parameters." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/keys/{id}": delete: operationId: "deleteApiKey" summary: "Revoke API key" description: "Requires Bearer gtmc_ authentication with admin tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "API Keys" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "API key id." schema: type: "integer" minimum: 1 responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/RevokedKeyResponse" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "/keys/{id}/rotate": post: operationId: "rotateApiKey" summary: "Rotate API key" description: "Requires Bearer gtmc_ authentication with admin tier access. API keys may be platform_admin, agency, or customer scoped; customer-scoped keys are limited to their bound customer." tags: - "API Keys" security: - bearerAuth: [] parameters: - name: "id" in: "path" required: true description: "API key id." schema: type: "integer" minimum: 1 responses: "200": description: "Successful response." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ApiKeyCreateResponse" "401": description: "Missing, malformed, invalid, or expired Bearer API key." headers: X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "403": description: "Authenticated key lacks the required scope or tier." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "404": description: "Resource not found, or not accessible to this key." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" "429": description: "Rate limit exceeded." headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" Retry-After: description: "Seconds until the client should retry after rate limiting." schema: type: "integer" minimum: 0 content: "application/json": schema: "$ref": "#/components/schemas/ErrorEnvelope" webhooks: "conversation.started": post: operationId: "receiveConversationStarted" summary: "Receive conversation.started" description: "This event is currently emitted. Verify X-GTMC-Signature by computing HMAC-SHA256 over the exact string \".\" with the endpoint secret and comparing it to the v1 value." tags: - "Webhook Events" parameters: - name: "X-GTMC-Signature" in: "header" required: true description: "Signature header formatted as t=,v1=." schema: type: "string" - name: "X-GTMC-Timestamp" in: "header" required: true description: "Unix timestamp used in the signed payload." schema: type: "integer" requestBody: required: true content: "application/json": schema: type: "object" required: - "name" - "data" properties: name: const: "conversation.started" data: type: "object" required: - "customerId" - "orgId" properties: customerId: type: "integer" minimum: 1 orgId: type: "string" additionalProperties: true additionalProperties: false responses: "200": description: "Webhook accepted by the subscriber." "400": description: "Subscriber rejected the payload." "conversation.ended": post: operationId: "receiveConversationEnded" summary: "Receive conversation.ended" description: "This event is currently emitted. Verify X-GTMC-Signature by computing HMAC-SHA256 over the exact string \".\" with the endpoint secret and comparing it to the v1 value." tags: - "Webhook Events" parameters: - name: "X-GTMC-Signature" in: "header" required: true description: "Signature header formatted as t=,v1=." schema: type: "string" - name: "X-GTMC-Timestamp" in: "header" required: true description: "Unix timestamp used in the signed payload." schema: type: "integer" requestBody: required: true content: "application/json": schema: type: "object" required: - "name" - "data" properties: name: const: "conversation.ended" data: type: "object" required: - "customerId" - "orgId" properties: customerId: type: "integer" minimum: 1 orgId: type: "string" additionalProperties: true additionalProperties: false responses: "200": description: "Webhook accepted by the subscriber." "400": description: "Subscriber rejected the payload." "identity.resolved": post: operationId: "receiveIdentityResolved" summary: "Receive identity.resolved" description: "This event is currently emitted. Verify X-GTMC-Signature by computing HMAC-SHA256 over the exact string \".\" with the endpoint secret and comparing it to the v1 value." tags: - "Webhook Events" parameters: - name: "X-GTMC-Signature" in: "header" required: true description: "Signature header formatted as t=,v1=." schema: type: "string" - name: "X-GTMC-Timestamp" in: "header" required: true description: "Unix timestamp used in the signed payload." schema: type: "integer" requestBody: required: true content: "application/json": schema: type: "object" required: - "name" - "data" properties: name: const: "identity.resolved" data: type: "object" required: - "customerId" - "orgId" properties: customerId: type: "integer" minimum: 1 orgId: type: "string" additionalProperties: true additionalProperties: false responses: "200": description: "Webhook accepted by the subscriber." "400": description: "Subscriber rejected the payload." "conversion.recorded": post: operationId: "receiveConversionRecorded" summary: "Receive conversion.recorded" description: "This event is currently emitted. Verify X-GTMC-Signature by computing HMAC-SHA256 over the exact string \".\" with the endpoint secret and comparing it to the v1 value." tags: - "Webhook Events" parameters: - name: "X-GTMC-Signature" in: "header" required: true description: "Signature header formatted as t=,v1=." schema: type: "string" - name: "X-GTMC-Timestamp" in: "header" required: true description: "Unix timestamp used in the signed payload." schema: type: "integer" requestBody: required: true content: "application/json": schema: type: "object" required: - "name" - "data" properties: name: const: "conversion.recorded" data: type: "object" required: - "customerId" - "orgId" properties: customerId: type: "integer" minimum: 1 orgId: type: "string" additionalProperties: true additionalProperties: false responses: "200": description: "Webhook accepted by the subscriber." "400": description: "Subscriber rejected the payload." "resolution.recorded": post: operationId: "receiveResolutionRecorded" summary: "Receive resolution.recorded" description: "This event is currently emitted. Verify X-GTMC-Signature by computing HMAC-SHA256 over the exact string \".\" with the endpoint secret and comparing it to the v1 value." tags: - "Webhook Events" parameters: - name: "X-GTMC-Signature" in: "header" required: true description: "Signature header formatted as t=,v1=." schema: type: "string" - name: "X-GTMC-Timestamp" in: "header" required: true description: "Unix timestamp used in the signed payload." schema: type: "integer" requestBody: required: true content: "application/json": schema: type: "object" required: - "name" - "data" properties: name: const: "resolution.recorded" data: type: "object" required: - "customerId" - "orgId" properties: customerId: type: "integer" minimum: 1 orgId: type: "string" additionalProperties: true additionalProperties: false responses: "200": description: "Webhook accepted by the subscriber." "400": description: "Subscriber rejected the payload." "handoff.requested": post: operationId: "receiveHandoffRequested" summary: "Receive handoff.requested" description: "This event is currently emitted. Verify X-GTMC-Signature by computing HMAC-SHA256 over the exact string \".\" with the endpoint secret and comparing it to the v1 value." tags: - "Webhook Events" parameters: - name: "X-GTMC-Signature" in: "header" required: true description: "Signature header formatted as t=,v1=." schema: type: "string" - name: "X-GTMC-Timestamp" in: "header" required: true description: "Unix timestamp used in the signed payload." schema: type: "integer" requestBody: required: true content: "application/json": schema: type: "object" required: - "name" - "data" properties: name: const: "handoff.requested" data: type: "object" required: - "customerId" - "orgId" properties: customerId: type: "integer" minimum: 1 orgId: type: "string" additionalProperties: true additionalProperties: false responses: "200": description: "Webhook accepted by the subscriber." "400": description: "Subscriber rejected the payload." "outcome.marked": post: operationId: "receiveOutcomeMarked" summary: "Receive outcome.marked" description: "This event is currently emitted. Verify X-GTMC-Signature by computing HMAC-SHA256 over the exact string \".\" with the endpoint secret and comparing it to the v1 value." tags: - "Webhook Events" parameters: - name: "X-GTMC-Signature" in: "header" required: true description: "Signature header formatted as t=,v1=." schema: type: "string" - name: "X-GTMC-Timestamp" in: "header" required: true description: "Unix timestamp used in the signed payload." schema: type: "integer" requestBody: required: true content: "application/json": schema: type: "object" required: - "name" - "data" properties: name: const: "outcome.marked" data: type: "object" required: - "customerId" - "orgId" properties: customerId: type: "integer" minimum: 1 orgId: type: "string" additionalProperties: true additionalProperties: false responses: "200": description: "Webhook accepted by the subscriber." "400": description: "Subscriber rejected the payload." components: securitySchemes: bearerAuth: type: "http" scheme: "bearer" bearerFormat: "gtmc_ API key" description: "Send Authorization: Bearer ." parameters: {} headers: X-RateLimit-Limit: description: "Maximum requests allowed in the current window." schema: type: "integer" X-RateLimit-Remaining: description: "Requests remaining in the current window." schema: type: "integer" X-RateLimit-Reset: description: "Unix timestamp when the current window resets." schema: type: "integer" X-Request-Id: description: "Request correlation id returned in every v1 response." schema: type: "string" schemas: AccountUsage: type: "object" properties: billingStatus: type: "string" enum: - "trialing" - "active" - "past_due" - "canceled" customers: type: "array" items: type: "object" properties: customerId: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 name: type: "string" conversionType: type: "string" active: type: "boolean" conversions: type: "integer" minimum: 0 maximum: 9007199254740991 billed: type: "integer" minimum: 0 maximum: 9007199254740991 unbilled: type: "integer" minimum: 0 maximum: 9007199254740991 spentCents: type: "integer" minimum: 0 maximum: 9007199254740991 priceCents: type: "integer" minimum: 0 maximum: 9007199254740991 spendCapCents: anyOf: - type: "integer" minimum: 0 maximum: 9007199254740991 - type: "null" billResolutions: type: "boolean" resolutions: type: "integer" minimum: 0 maximum: 9007199254740991 resolutionsBilled: type: "integer" minimum: 0 maximum: 9007199254740991 resolutionsUnbilled: type: "integer" minimum: 0 maximum: 9007199254740991 resolutionSpentCents: type: "integer" minimum: 0 maximum: 9007199254740991 resolutionPriceCents: type: "integer" minimum: 0 maximum: 9007199254740991 resolutionHasOverride: type: "boolean" required: - "customerId" - "name" - "conversionType" - "active" - "conversions" - "billed" - "unbilled" - "spentCents" - "priceCents" - "spendCapCents" - "billResolutions" - "resolutions" - "resolutionsBilled" - "resolutionsUnbilled" - "resolutionSpentCents" - "resolutionPriceCents" - "resolutionHasOverride" additionalProperties: false resolutionDefaultCents: anyOf: - type: "integer" minimum: 0 maximum: 9007199254740991 - type: "null" totals: type: "object" properties: conversions: type: "integer" minimum: 0 maximum: 9007199254740991 spentCents: type: "integer" minimum: 0 maximum: 9007199254740991 resolutions: type: "integer" minimum: 0 maximum: 9007199254740991 resolutionSpentCents: type: "integer" minimum: 0 maximum: 9007199254740991 required: - "conversions" - "spentCents" - "resolutions" - "resolutionSpentCents" additionalProperties: false required: - "billingStatus" - "customers" - "resolutionDefaultCents" - "totals" additionalProperties: false ApiKeyCreateRequest: type: "object" properties: name: type: "string" minLength: 1 maxLength: 100 tier: type: "string" enum: - "read" - "write" - "admin" scope: type: "string" enum: - "agency" - "customer" customerId: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 expiresAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" required: - "name" - "tier" - "scope" additionalProperties: false ApiKeyCreateResponse: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 name: type: "string" keyPrefix: type: "string" tier: type: "string" enum: - "read" - "write" - "admin" scope: type: "string" enum: - "platform_admin" - "agency" - "customer" customerId: anyOf: - type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 - type: "null" status: type: "string" enum: - "active" - "revoked" lastUsedAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" expiresAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" createdAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" plaintext: type: "string" required: - "id" - "name" - "keyPrefix" - "tier" - "scope" - "customerId" - "status" - "lastUsedAt" - "expiresAt" - "createdAt" - "plaintext" additionalProperties: false ApiKeyListResponse: type: "object" properties: data: type: "array" items: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 name: type: "string" keyPrefix: type: "string" tier: type: "string" enum: - "read" - "write" - "admin" scope: type: "string" enum: - "platform_admin" - "agency" - "customer" customerId: anyOf: - type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 - type: "null" status: type: "string" enum: - "active" - "revoked" lastUsedAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" expiresAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" createdAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" required: - "id" - "name" - "keyPrefix" - "tier" - "scope" - "customerId" - "status" - "lastUsedAt" - "expiresAt" - "createdAt" additionalProperties: false required: - "data" additionalProperties: false Conversation: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 status: type: "string" enum: - "open" - "ai_active" - "human_active" - "closed" - "converted" converted: type: "boolean" convertedAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" identityResolved: type: "boolean" visitorId: anyOf: - type: "string" - type: "null" startedAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" endedAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" required: - "id" - "status" - "converted" - "convertedAt" - "identityResolved" - "visitorId" - "startedAt" - "endedAt" additionalProperties: false ConversationListResponse: type: "object" properties: data: type: "array" items: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 status: type: "string" enum: - "open" - "ai_active" - "human_active" - "closed" - "converted" converted: type: "boolean" convertedAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" identityResolved: type: "boolean" visitorId: anyOf: - type: "string" - type: "null" startedAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" endedAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" required: - "id" - "status" - "converted" - "convertedAt" - "identityResolved" - "visitorId" - "startedAt" - "endedAt" additionalProperties: false has_more: type: "boolean" required: - "data" - "has_more" additionalProperties: false Conversion: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 conversationId: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 customerId: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 type: type: "string" enum: - "booked_meeting" - "qualified_lead" - "sale" - "resolved_ticket" - "custom" - "captured_contact" - "qualified_meeting" value: anyOf: - type: "string" - type: "null" billedAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" billedCents: anyOf: - type: "integer" minimum: -9007199254740991 maximum: 9007199254740991 - type: "null" reversedAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" createdAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" required: - "id" - "conversationId" - "customerId" - "type" - "value" - "billedAt" - "billedCents" - "reversedAt" - "createdAt" additionalProperties: false ConversionListResponse: type: "object" properties: data: type: "array" items: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 conversationId: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 customerId: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 type: type: "string" enum: - "booked_meeting" - "qualified_lead" - "sale" - "resolved_ticket" - "custom" - "captured_contact" - "qualified_meeting" value: anyOf: - type: "string" - type: "null" billedAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" billedCents: anyOf: - type: "integer" minimum: -9007199254740991 maximum: 9007199254740991 - type: "null" reversedAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" createdAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" required: - "id" - "conversationId" - "customerId" - "type" - "value" - "billedAt" - "billedCents" - "reversedAt" - "createdAt" additionalProperties: false has_more: type: "boolean" required: - "data" - "has_more" additionalProperties: false Customer: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 orgId: type: "string" name: type: "string" widgetKey: type: "string" conversionType: type: "string" enum: - "booked_meeting" - "qualified_lead" - "sale" - "resolved_ticket" - "custom" - "captured_contact" - "qualified_meeting" conversionLabel: anyOf: - type: "string" - type: "null" personaPrompt: anyOf: - type: "string" - type: "null" allowedScope: anyOf: - type: "string" - type: "null" refusalPolicy: anyOf: - type: "string" - type: "null" brandColor: type: "string" escalationThreshold: type: "number" motion: anyOf: - type: "string" enum: - "demo_booking" - "quote" - "self_serve" - "purchase" - "qualification" - "support" - type: "null" vertical: anyOf: - type: "string" - type: "null" provisioningStatus: type: "string" enum: - "pending" - "ready" - "failed" active: type: "boolean" createdAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" updatedAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" delivrPixelId: anyOf: - type: "string" - type: "null" leadEmailRecipients: type: "array" items: type: "string" leadEmailTranscript: type: "boolean" required: - "id" - "orgId" - "name" - "widgetKey" - "conversionType" - "conversionLabel" - "personaPrompt" - "allowedScope" - "refusalPolicy" - "brandColor" - "escalationThreshold" - "motion" - "vertical" - "provisioningStatus" - "active" - "createdAt" - "updatedAt" - "delivrPixelId" - "leadEmailRecipients" - "leadEmailTranscript" additionalProperties: false CustomerCreateRequest: type: "object" properties: name: type: "string" minLength: 1 maxLength: 200 personaPrompt: type: "string" conversionType: type: "string" enum: - "booked_meeting" - "qualified_lead" - "sale" - "resolved_ticket" - "custom" - "captured_contact" - "qualified_meeting" conversionLabel: type: "string" allowedScope: type: "string" refusalPolicy: type: "string" brandColor: type: "string" pattern: "^#[\\da-f]{6}$" motion: type: "string" enum: - "demo_booking" - "quote" - "self_serve" - "purchase" - "qualification" - "support" vertical: type: "string" minLength: 1 required: - "name" additionalProperties: false CustomerListResponse: type: "object" properties: data: type: "array" items: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 orgId: type: "string" name: type: "string" widgetKey: type: "string" conversionType: type: "string" enum: - "booked_meeting" - "qualified_lead" - "sale" - "resolved_ticket" - "custom" - "captured_contact" - "qualified_meeting" conversionLabel: anyOf: - type: "string" - type: "null" personaPrompt: anyOf: - type: "string" - type: "null" allowedScope: anyOf: - type: "string" - type: "null" refusalPolicy: anyOf: - type: "string" - type: "null" brandColor: type: "string" escalationThreshold: type: "number" motion: anyOf: - type: "string" enum: - "demo_booking" - "quote" - "self_serve" - "purchase" - "qualification" - "support" - type: "null" vertical: anyOf: - type: "string" - type: "null" provisioningStatus: type: "string" enum: - "pending" - "ready" - "failed" active: type: "boolean" createdAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" updatedAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" delivrPixelId: anyOf: - type: "string" - type: "null" leadEmailRecipients: type: "array" items: type: "string" leadEmailTranscript: type: "boolean" required: - "id" - "orgId" - "name" - "widgetKey" - "conversionType" - "conversionLabel" - "personaPrompt" - "allowedScope" - "refusalPolicy" - "brandColor" - "escalationThreshold" - "motion" - "vertical" - "provisioningStatus" - "active" - "createdAt" - "updatedAt" - "delivrPixelId" - "leadEmailRecipients" - "leadEmailTranscript" additionalProperties: false has_more: type: "boolean" required: - "data" - "has_more" additionalProperties: false CustomerPatchRequest: type: "object" properties: name: type: "string" minLength: 1 maxLength: 200 personaPrompt: anyOf: - type: "string" - type: "null" conversionType: type: "string" enum: - "booked_meeting" - "qualified_lead" - "sale" - "resolved_ticket" - "custom" - "captured_contact" - "qualified_meeting" conversionLabel: anyOf: - type: "string" - type: "null" allowedScope: anyOf: - type: "string" - type: "null" refusalPolicy: anyOf: - type: "string" - type: "null" brandColor: type: "string" pattern: "^#[\\da-f]{6}$" escalationThreshold: type: "number" minimum: 0 maximum: 1 motion: anyOf: - type: "string" enum: - "demo_booking" - "quote" - "self_serve" - "purchase" - "qualification" - "support" - type: "null" vertical: anyOf: - type: "string" minLength: 1 - type: "null" additionalProperties: false WidgetConfigPatchRequest: type: "object" properties: name: type: "string" minLength: 1 maxLength: 200 personaPrompt: anyOf: - type: "string" - type: "null" conversionType: type: "string" enum: - "booked_meeting" - "qualified_lead" - "sale" - "resolved_ticket" - "custom" - "captured_contact" - "qualified_meeting" conversionLabel: anyOf: - type: "string" - type: "null" allowedScope: anyOf: - type: "string" - type: "null" refusalPolicy: anyOf: - type: "string" - type: "null" brandColor: type: "string" pattern: "^#[\\da-f]{6}$" escalationThreshold: type: "number" minimum: 0 maximum: 1 motion: anyOf: - type: "string" enum: - "demo_booking" - "quote" - "self_serve" - "purchase" - "qualification" - "support" - type: "null" vertical: anyOf: - type: "string" minLength: 1 - type: "null" additionalProperties: false DeletedResponse: type: "object" properties: deleted: type: "boolean" id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 required: - "deleted" - "id" additionalProperties: false ErrorEnvelope: type: "object" properties: error: type: "object" properties: type: type: "string" enum: - "invalid_request_error" - "authentication_error" - "permission_error" - "rate_limit_error" - "idempotency_error" - "not_found_error" - "api_error" code: type: "string" message: type: "string" request_id: type: "string" required: - "type" - "code" - "message" - "request_id" additionalProperties: false required: - "error" additionalProperties: false IdentityListResponse: type: "object" properties: data: type: "array" items: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 conversationId: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 resolvedPersonId: anyOf: - type: "string" - type: "null" resolvedCompany: anyOf: - type: "string" - type: "null" createdAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" payload: {} required: - "id" - "conversationId" - "resolvedPersonId" - "resolvedCompany" - "createdAt" additionalProperties: false has_more: type: "boolean" required: - "data" - "has_more" additionalProperties: false MessageListResponse: type: "object" properties: data: type: "array" items: type: "object" properties: id: type: "integer" minimum: 0 maximum: 9007199254740991 role: type: "string" enum: - "user" - "assistant" - "agent" - "system" content: type: "string" createdAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" required: - "id" - "role" - "content" - "createdAt" additionalProperties: false has_more: type: "boolean" required: - "data" - "has_more" additionalProperties: false RevokedKeyResponse: type: "object" properties: revoked: type: "boolean" id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 self_revoked: description: "Present and true when the revoked API key authenticated the request." type: "boolean" required: - "revoked" - "id" additionalProperties: false Resolution: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 conversationId: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 customerId: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 resolvedPersonId: anyOf: - type: "string" - type: "null" resolvedCompany: anyOf: - type: "string" - type: "null" billedAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" billedCents: anyOf: - type: "integer" minimum: -9007199254740991 maximum: 9007199254740991 - type: "null" reversedAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" createdAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" required: - "id" - "conversationId" - "customerId" - "resolvedPersonId" - "resolvedCompany" - "billedAt" - "billedCents" - "reversedAt" - "createdAt" additionalProperties: false ResolutionListResponse: type: "object" properties: data: type: "array" items: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 conversationId: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 customerId: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 resolvedPersonId: anyOf: - type: "string" - type: "null" resolvedCompany: anyOf: - type: "string" - type: "null" billedAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" billedCents: anyOf: - type: "integer" minimum: -9007199254740991 maximum: 9007199254740991 - type: "null" reversedAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" createdAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" required: - "id" - "conversationId" - "customerId" - "resolvedPersonId" - "resolvedCompany" - "billedAt" - "billedCents" - "reversedAt" - "createdAt" additionalProperties: false has_more: type: "boolean" required: - "data" - "has_more" additionalProperties: false RotatedSecretResponse: type: "object" properties: endpoint: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 customerId: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 url: type: "string" format: "uri" description: anyOf: - type: "string" - type: "null" events: anyOf: - type: "array" items: type: "string" enum: - "conversation.started" - "conversation.ended" - "identity.resolved" - "conversion.recorded" - "resolution.recorded" - "handoff.requested" - "outcome.marked" - type: "null" active: type: "boolean" createdAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" required: - "id" - "customerId" - "url" - "description" - "events" - "active" - "createdAt" additionalProperties: false secret: type: "string" required: - "endpoint" - "secret" additionalProperties: false UsageTimeseries: type: "object" properties: granularity: type: "string" enum: - "day" - "week" from: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" to: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" buckets: type: "array" items: type: "object" properties: bucket: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" conversions: type: "integer" minimum: 0 maximum: 9007199254740991 resolutions: type: "integer" minimum: 0 maximum: 9007199254740991 conversionSpentCents: type: "integer" minimum: 0 maximum: 9007199254740991 resolutionSpentCents: type: "integer" minimum: 0 maximum: 9007199254740991 required: - "bucket" - "conversions" - "resolutions" - "conversionSpentCents" - "resolutionSpentCents" additionalProperties: false required: - "granularity" - "from" - "to" - "buckets" additionalProperties: false WebhookDeliveryListResponse: type: "object" properties: data: type: "array" items: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 eventName: type: "string" enum: - "conversation.started" - "conversation.ended" - "identity.resolved" - "conversion.recorded" - "resolution.recorded" - "handoff.requested" - "outcome.marked" attempt: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 status: type: "string" ok: type: "boolean" error: anyOf: - type: "string" - type: "null" createdAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" nextRetryAt: anyOf: - type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" - type: "null" required: - "id" - "eventName" - "attempt" - "status" - "ok" - "error" - "createdAt" - "nextRetryAt" additionalProperties: false nextCursor: anyOf: - type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 - type: "null" required: - "data" - "nextCursor" additionalProperties: false WebhookEndpoint: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 customerId: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 url: type: "string" format: "uri" description: anyOf: - type: "string" - type: "null" events: anyOf: - type: "array" items: type: "string" enum: - "conversation.started" - "conversation.ended" - "identity.resolved" - "conversion.recorded" - "resolution.recorded" - "handoff.requested" - "outcome.marked" - type: "null" active: type: "boolean" createdAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" required: - "id" - "customerId" - "url" - "description" - "events" - "active" - "createdAt" additionalProperties: false WebhookEndpointCreateRequest: type: "object" properties: url: {} description: anyOf: - type: "string" minLength: 1 maxLength: 500 - type: "null" events: anyOf: - type: "array" items: type: "string" enum: - "conversation.started" - "conversation.ended" - "identity.resolved" - "conversion.recorded" - "resolution.recorded" - "handoff.requested" - "outcome.marked" - type: "null" required: - "url" additionalProperties: false WebhookEndpointCreateResponse: type: "object" properties: endpoint: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 customerId: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 url: type: "string" format: "uri" description: anyOf: - type: "string" - type: "null" events: anyOf: - type: "array" items: type: "string" enum: - "conversation.started" - "conversation.ended" - "identity.resolved" - "conversion.recorded" - "resolution.recorded" - "handoff.requested" - "outcome.marked" - type: "null" active: type: "boolean" createdAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" required: - "id" - "customerId" - "url" - "description" - "events" - "active" - "createdAt" additionalProperties: false secret: type: "string" required: - "endpoint" - "secret" additionalProperties: false WebhookEndpointListResponse: type: "object" properties: data: type: "array" items: type: "object" properties: id: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 customerId: type: "integer" exclusiveMinimum: 0 maximum: 9007199254740991 url: type: "string" format: "uri" description: anyOf: - type: "string" - type: "null" events: anyOf: - type: "array" items: type: "string" enum: - "conversation.started" - "conversation.ended" - "identity.resolved" - "conversion.recorded" - "resolution.recorded" - "handoff.requested" - "outcome.marked" - type: "null" active: type: "boolean" createdAt: type: "string" format: "date-time" pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" required: - "id" - "customerId" - "url" - "description" - "events" - "active" - "createdAt" additionalProperties: false required: - "data" additionalProperties: false WebhookEndpointPatchRequest: type: "object" properties: url: {} description: anyOf: - type: "string" minLength: 1 maxLength: 500 - type: "null" events: anyOf: - type: "array" items: type: "string" enum: - "conversation.started" - "conversation.ended" - "identity.resolved" - "conversion.recorded" - "resolution.recorded" - "handoff.requested" - "outcome.marked" - type: "null" active: type: "boolean" additionalProperties: false WidgetConfig: type: "object" properties: personaPrompt: anyOf: - type: "string" - type: "null" conversionType: type: "string" enum: - "booked_meeting" - "qualified_lead" - "sale" - "resolved_ticket" - "custom" - "captured_contact" - "qualified_meeting" conversionLabel: anyOf: - type: "string" - type: "null" allowedScope: anyOf: - type: "string" - type: "null" refusalPolicy: anyOf: - type: "string" - type: "null" brandColor: type: "string" escalationThreshold: type: "number" motion: anyOf: - type: "string" enum: - "demo_booking" - "quote" - "self_serve" - "purchase" - "qualification" - "support" - type: "null" vertical: anyOf: - type: "string" - type: "null" widgetKey: type: "string" delivrPixelId: anyOf: - type: "string" - type: "null" required: - "personaPrompt" - "conversionType" - "conversionLabel" - "allowedScope" - "refusalPolicy" - "brandColor" - "escalationThreshold" - "motion" - "vertical" - "widgetKey" - "delivrPixelId" additionalProperties: false