{ "openapi": "3.1.0", "info": { "title": "RevUp Public Data API", "version": "1.0.0", "description": "Tenant-scoped, RBAC-scoped and entitlement-gated API." }, "servers": [ { "url": "https://revup.cl/{slug}/api/public/v1", "variables": { "slug": { "default": "tenant-slug", "description": "RevUp tenant slug" } } } ], "security": [ { "bearerApiKey": [] } ], "paths": { "/activities": { "get": { "operationId": "listActivities", "summary": "actividades / activities", "description": "Devuelve actividades dentro del tenant autorizado. Returns activities within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "activities:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "activity_reporting_index" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "owner_user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "activity_type", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/activities/{id}": { "get": { "operationId": "getActivity", "summary": "una actividad / one activity", "description": "Devuelve una actividad dentro del tenant autorizado. Returns one activity within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "activities:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "activity_reporting_index" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "owner_user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "activity_type", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/ai/usage": { "get": { "operationId": "listAiUsage", "summary": "consumo agregado de IA / aggregated AI usage", "description": "Devuelve consumo agregado de IA dentro del tenant autorizado. Returns aggregated AI usage within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "ai_usage:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "ai_usage_outbox" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "provider", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/audit-events": { "get": { "operationId": "listAuditEvents", "summary": "eventos de auditoría sanitizados / sanitized audit events", "description": "Devuelve eventos de auditoría sanitizados dentro del tenant autorizado. Returns sanitized audit events within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "audit:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "audit_event_ledger" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "actor_user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "resource_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "resource_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "correlation_id", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/catalogs/{type}": { "get": { "operationId": "getCatalog", "summary": "un catálogo / a catalog", "description": "Devuelve un catálogo dentro del tenant autorizado. Returns a catalog within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "products:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "product_catalog" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "billing_period", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "product_type", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/changes": { "get": { "operationId": "listChanges", "summary": "cambios incrementales / incremental changes", "description": "Devuelve cambios incrementales dentro del tenant autorizado. Returns incremental changes within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "changes:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "audit_event_ledger" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "resource_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "change_type", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/changes.php": { "get": { "operationId": "listChangesLegacyPhp", "summary": "cambios incrementales / incremental changes", "description": "Devuelve cambios incrementales dentro del tenant autorizado. Returns incremental changes within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "changes:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "audit_event_ledger" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "resource_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "change_type", "in": "query", "required": false, "schema": { "type": "string" } } ], "deprecated": true } }, "/clients": { "get": { "operationId": "listClients", "summary": "clientes / clients", "description": "Devuelve clientes dentro del tenant autorizado. Returns clients within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "clients:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "clients" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/clients.php": { "get": { "operationId": "listClientsLegacyPhp", "summary": "clientes / clients", "description": "Devuelve clientes dentro del tenant autorizado. Returns clients within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "clients:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "clients" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ], "deprecated": true } }, "/clients/{id}": { "get": { "operationId": "getClient", "summary": "un cliente / one client", "description": "Devuelve un cliente dentro del tenant autorizado. Returns one client within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "clients:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "clients" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/clients/{id}/timeline": { "get": { "operationId": "getClientTimeline", "summary": "la línea de tiempo del cliente / the client timeline", "description": "Devuelve la línea de tiempo del cliente dentro del tenant autorizado. Returns the client timeline within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "clients:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "clients" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/commitments": { "get": { "operationId": "listCommitments", "summary": "compromisos / commitments", "description": "Devuelve compromisos dentro del tenant autorizado. Returns commitments within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "commitments:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "customer_commitments" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "owner_user_id", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/contacts": { "get": { "operationId": "listContacts", "summary": "contactos / contacts", "description": "Devuelve contactos dentro del tenant autorizado. Returns contacts within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "contacts:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "contacts", "clients" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/contacts/{id}": { "get": { "operationId": "getContact", "summary": "un contacto / one contact", "description": "Devuelve un contacto dentro del tenant autorizado. Returns one contact within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "contacts:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "contacts", "clients" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/customer-success": { "get": { "operationId": "listCustomerSuccess", "summary": "resúmenes de customer success / customer success summaries", "description": "Devuelve resúmenes de customer success dentro del tenant autorizado. Returns customer success summaries within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "customer_success:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "customer_success_plans", "clients" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "owner_user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "health_status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "risk_level", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/customer-success/{clientId}": { "get": { "operationId": "getCustomerSuccess", "summary": "el resumen de customer success del cliente / the client customer success summary", "description": "Devuelve el resumen de customer success del cliente dentro del tenant autorizado. Returns the client customer success summary within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "customer_success:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "customer_success_plans", "clients" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "owner_user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "health_status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "risk_level", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/export-download.php": { "get": { "operationId": "downloadExportLegacyPhp", "deprecated": true, "x-revup-scope": "exports:read", "responses": { "200": { "description": "Download" } } } }, "/exports": { "post": { "operationId": "createExport", "summary": "un trabajo de exportación / an export job", "description": "Devuelve un trabajo de exportación dentro del tenant autorizado. Returns an export job within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "exports:write", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "public_api_bulk_exports" ], "responses": { "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "202": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportRequest" } } } } } }, "/exports.php": { "post": { "operationId": "createExportLegacyPhp", "deprecated": true, "x-revup-scope": "exports:write", "responses": { "202": { "description": "Queued" } } }, "get": { "operationId": "getExportLegacyPhp", "deprecated": true, "x-revup-scope": "exports:read", "responses": { "200": { "description": "Status" } } } }, "/exports/{id}": { "delete": { "operationId": "deleteExport", "summary": "la eliminación de una exportación / an export deletion", "description": "Devuelve la eliminación de una exportación dentro del tenant autorizado. Returns an export deletion within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "exports:delete", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "public_api_bulk_exports" ], "responses": { "204": { "description": "Deleted" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "operationId": "getExport", "summary": "el estado de una exportación / an export status", "description": "Devuelve el estado de una exportación dentro del tenant autorizado. Returns an export status within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "exports:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "public_api_bulk_exports" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/exports/{id}/download": { "get": { "operationId": "downloadExport", "summary": "el archivo exportado / the exported file", "description": "Devuelve el archivo exportado dentro del tenant autorizado. Returns the exported file within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "exports:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "public_api_bulk_exports" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/feedback": { "get": { "operationId": "listFeedback", "summary": "feedback / feedback", "description": "Devuelve feedback dentro del tenant autorizado. Returns feedback within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "feedback:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "customer_feedback_items" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/forecast": { "get": { "operationId": "listForecast", "summary": "pronóstico comercial / sales forecast", "description": "Devuelve pronóstico comercial dentro del tenant autorizado. Returns sales forecast within the authorized tenant. Deprecated; use /opportunities.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "forecast:read", "x-revup-lifecycle": "deprecated", "x-revup-canonical-sources": [ "forecast_daily_snapshots", "opportunity_kanban_items", "OpportunityMetricsService" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "deprecated": true, "x-revup-replacement": "/opportunities", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "owner_user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/goals": { "get": { "operationId": "listGoals", "summary": "metas / goals", "description": "Devuelve metas dentro del tenant autorizado. Returns goals within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "goals:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "kpi_targets_advanced", "KpiTargetResolver" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "owner_user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/health": { "get": { "operationId": "getHealth", "summary": "estado de la API / API health", "description": "Devuelve estado de la API dentro del tenant autorizado. Returns API health within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "health:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "public_api_runtime" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } } } }, "/health.php": { "get": { "operationId": "getHealthLegacyPhp", "summary": "estado de la API / API health", "description": "Devuelve estado de la API dentro del tenant autorizado. Returns API health within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "health:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "public_api_runtime" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "deprecated": true } }, "/kpis": { "get": { "operationId": "listKpis", "summary": "indicadores KPI / KPI indicators", "description": "Devuelve indicadores KPI dentro del tenant autorizado. Returns KPI indicators within the authorized tenant. Deprecated; use /goals.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "kpis:read", "x-revup-lifecycle": "deprecated", "x-revup-canonical-sources": [ "kpi_metric_catalog", "OpportunityMetricsService", "KpiTargetResolver" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "deprecated": true, "x-revup-replacement": "/goals", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "owner_user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/market-intelligence": { "get": { "operationId": "listMarketIntelligence", "summary": "hallazgos de inteligencia de mercado / market intelligence findings", "description": "Devuelve hallazgos de inteligencia de mercado dentro del tenant autorizado. Returns market intelligence findings within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "market_intelligence:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "market_intelligence_findings" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "finding_type", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/opportunities": { "get": { "operationId": "listOpportunities", "summary": "oportunidades / opportunities", "description": "Devuelve oportunidades dentro del tenant autorizado. Returns opportunities within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "opportunities:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "opportunity_kanban_items", "role_funnels", "funnel_stages", "OpportunityMetricsService" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "owner_user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/opportunities.php": { "get": { "operationId": "listOpportunitiesLegacyPhp", "summary": "oportunidades / opportunities", "description": "Devuelve oportunidades dentro del tenant autorizado. Returns opportunities within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "opportunities:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "opportunity_kanban_items", "role_funnels", "funnel_stages", "OpportunityMetricsService" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "owner_user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } } ], "deprecated": true } }, "/opportunities/{id}": { "get": { "operationId": "getOpportunity", "summary": "una oportunidad / one opportunity", "description": "Devuelve una oportunidad dentro del tenant autorizado. Returns one opportunity within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "opportunities:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "opportunity_kanban_items", "role_funnels", "funnel_stages", "OpportunityMetricsService" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "owner_user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/pipeline/snapshots": { "get": { "operationId": "listPipelineSnapshots", "summary": "instantáneas del pipeline / pipeline snapshots", "description": "Devuelve instantáneas del pipeline dentro del tenant autorizado. Returns pipeline snapshots within the authorized tenant. Deprecated; use /opportunities.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "pipeline:read", "x-revup-lifecycle": "deprecated", "x-revup-canonical-sources": [ "opportunity_kanban_items", "OpportunityMetricsService" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "deprecated": true, "x-revup-replacement": "/opportunities", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "owner_user_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/products": { "get": { "operationId": "listProducts", "summary": "productos / products", "description": "Devuelve productos dentro del tenant autorizado. Returns products within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "products:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "product_catalog" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "billing_period", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "product_type", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/products/{id}": { "get": { "operationId": "getProduct", "summary": "un producto / one product", "description": "Devuelve un producto dentro del tenant autorizado. Returns one product within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "products:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "product_catalog" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "billing_period", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "product_type", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/users": { "get": { "operationId": "listUsers", "summary": "usuarios autorizados / authorized users", "description": "Devuelve usuarios autorizados dentro del tenant autorizado. Returns authorized users within the authorized tenant.", "security": [ { "bearerApiKey": [] } ], "x-revup-scope": "users:read", "x-revup-lifecycle": "active", "x-revup-canonical-sources": [ "app_users", "app_roles" ], "responses": { "200": { "description": "Successful governed response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "422": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "role_code", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "team_code", "in": "query", "required": false, "schema": { "type": "string" } } ] } } }, "components": { "securitySchemes": { "bearerApiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "rvp__." } }, "schemas": { "Activity": { "type": "object", "properties": { "id": { "type": "integer" }, "client_id": { "type": "integer" }, "opportunity_id": { "type": "string" }, "activity_type": { "type": "string" }, "subject": { "type": "string" }, "description": { "type": "string" }, "occurred_at": { "type": "string" }, "due_at": { "type": "string" }, "status": { "type": "string" }, "owner_user_id": { "type": "integer" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "AiUsage": { "type": "object", "properties": { "id": { "type": "integer" }, "period": { "type": "string" }, "provider": { "type": "string" }, "model": { "type": "string" }, "operation_count": { "type": "integer" }, "model_usage_units": { "type": "string" }, "error_count": { "type": "integer" }, "currency": { "type": "string" }, "provider_cost": { "type": "string" }, "billable_amount": { "type": "string" }, "is_billable": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "AuditEvent": { "type": "object", "properties": { "id": { "type": "integer" }, "action": { "type": "string" }, "actor_user_id": { "type": "string" }, "resource_type": { "type": "string" }, "resource_id": { "type": "string" }, "correlation_id": { "type": "string" }, "result": { "type": "string" }, "occurred_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "ChangeEvent": { "type": "object", "properties": { "id": { "type": "integer" }, "resource_type": { "type": "string" }, "resource_id": { "type": "string" }, "change_type": { "type": "string" }, "changed_at": { "type": "string" }, "correlation_id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "Client": { "type": "object", "properties": { "id": { "type": "integer" }, "company_code": { "type": "string" }, "legal_name": { "type": "string" }, "trade_name": { "type": "string" }, "tax_identifier": { "type": "string" }, "country_code": { "type": "string" }, "region": { "type": "string" }, "municipality": { "type": "string" }, "industry_code": { "type": "string" }, "billing_method": { "type": "string" }, "payment_method": { "type": "string" }, "status": { "type": "string" }, "owner_user_id": { "type": "integer" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "Commitment": { "type": "object", "properties": { "id": { "type": "integer" }, "client_id": { "type": "integer" }, "opportunity_id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "due_at": { "type": "string" }, "completed_at": { "type": "string" }, "status": { "type": "string" }, "owner_user_id": { "type": "integer" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "Contact": { "type": "object", "properties": { "id": { "type": "integer" }, "client_id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "job_title": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "is_primary": { "type": "string" }, "status": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "CustomerSuccess": { "type": "object", "properties": { "id": { "type": "integer" }, "client_id": { "type": "integer" }, "health_status": { "type": "string" }, "health_score": { "type": "string" }, "risk_level": { "type": "string" }, "last_contact_at": { "type": "string" }, "next_action_at": { "type": "string" }, "owner_user_id": { "type": "integer" }, "status": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "Feedback": { "type": "object", "properties": { "id": { "type": "integer" }, "client_id": { "type": "integer" }, "feedback_code": { "type": "string" }, "category": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "submitted_by_user_id": { "type": "string" }, "assigned_to_user_id": { "type": "string" }, "resolved_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "Forecast": { "type": "object", "properties": { "id": { "type": "integer" }, "period": { "type": "string" }, "currency": { "type": "string" }, "category": { "type": "string" }, "forecast_amount": { "type": "string" }, "committed_amount": { "type": "string" }, "best_case_amount": { "type": "string" }, "owner_user_id": { "type": "integer" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "Goal": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "period": { "type": "string" }, "target_value": { "type": "string" }, "actual_value": { "type": "string" }, "unit": { "type": "string" }, "owner_user_id": { "type": "integer" }, "status": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "Kpi": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "name": { "type": "string" }, "period": { "type": "string" }, "value": { "type": "string" }, "unit": { "type": "string" }, "target_value": { "type": "string" }, "owner_user_id": { "type": "integer" }, "status": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "MarketIntelligenceFinding": { "type": "object", "properties": { "id": { "type": "integer" }, "source": { "type": "string" }, "finding_type": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": "string" }, "published_at": { "type": "string" }, "relevance_score": { "type": "string" }, "status": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "Opportunity": { "type": "object", "properties": { "id": { "type": "integer" }, "client_id": { "type": "integer" }, "name": { "type": "string" }, "stage": { "type": "string" }, "status": { "type": "string" }, "currency": { "type": "string" }, "amount": { "type": "string" }, "probability_percent": { "type": "string" }, "expected_close_date": { "type": "string" }, "owner_user_id": { "type": "integer" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "PipelineSnapshot": { "type": "object", "properties": { "id": { "type": "integer" }, "snapshot_at": { "type": "string" }, "stage": { "type": "string" }, "currency": { "type": "string" }, "opportunity_count": { "type": "string" }, "weighted_amount": { "type": "string" }, "unweighted_amount": { "type": "string" }, "owner_user_id": { "type": "integer" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "Product": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "product_type": { "type": "string" }, "billing_period": { "type": "string" }, "currency": { "type": "string" }, "unit_price": { "type": "string" }, "status": { "type": "string" }, "valid_from": { "type": "string" }, "valid_to": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "User": { "type": "object", "properties": { "id": { "type": "integer" }, "display_name": { "type": "string" }, "email": { "type": "string" }, "role_code": { "type": "string" }, "team_code": { "type": "string" }, "is_active": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": false }, "SuccessEnvelope": { "type": "object", "required": [ "ok", "data", "meta" ], "properties": { "ok": { "type": "boolean", "const": true }, "data": [], "meta": { "type": "object" } } }, "ErrorEnvelope": { "type": "object", "required": [ "ok", "error" ], "properties": { "ok": { "type": "boolean", "const": false }, "error": { "type": "object" } } }, "ExportRequest": { "type": "object", "required": [ "resource_type", "format" ], "properties": { "resource_type": { "type": "string", "enum": [ "CLIENTS", "CONTACTS", "PRODUCTS", "OPPORTUNITIES", "ACTIVITIES", "CLIENT_TIMELINE", "COMMITMENTS", "PIPELINE_SNAPSHOTS", "FORECAST", "KPIS", "GOALS", "USERS", "CUSTOMER_SUCCESS", "FEEDBACK", "AUDIT_EVENTS", "AI_USAGE", "MARKET_INTELLIGENCE" ] }, "format": { "type": "string", "enum": [ "CSV", "JSONL", "XLSX" ] }, "filters": { "type": "object" } } } }, "responses": { "Error": { "description": "Stable sanitized error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }