{ "openapi": "3.1.0", "info": { "title": "GHOST OSINT CRM API", "version": "2.23.0", "description": "REST API for GHOST. All endpoints (except login/session) require an authenticated session cookie — POST /api/auth/login first and reuse the cookie. Validation errors return field-level detail: `{ \"error\": \"Validation failed\", \"fields\": { \"\": [\"\"] } }`. Endpoints marked x-requires-admin need an admin-role session." }, "servers": [ { "url": "/api", "description": "Relative to your own GHOST instance" } ], "security": [ { "cookieAuth": [] } ], "tags": [ { "name": "Auth", "description": "Session login/logout and the current user profile." }, { "name": "Projects", "description": "Projects are the isolation boundary: every case-scoped record belongs to exactly one. Non-admins only reach projects they are members of, with one role per project: owner > manager > investigator. Owners and managers edit project settings; membership changes are allowed only on members ranked below the caller, never on the caller themselves, and only admins appoint or remove owners. Creating and deleting projects is admin-only." }, { "name": "Cases", "description": "Cases group records inside a project." }, { "name": "People", "description": "Person records, including their locations." }, { "name": "Travel History", "description": "Travel entries and pattern analysis for a person." }, { "name": "Businesses", "description": "Organisations, their staff, and ownership chains." }, { "name": "Relationships", "description": "Typed links between people, businesses and crypto wallets." }, { "name": "Properties", "description": "Real estate and other mappable property." }, { "name": "Assets", "description": "Tracked items of value and who holds them." }, { "name": "Crypto Wallets", "description": "Wallet addresses as entities. GHOST records them; it does not do chain analysis." }, { "name": "Files", "description": "Documents attached to a person or to a project. Any project member may upload, download and edit them; deleting needs the uploader, a project owner or manager, or an admin. Every upload, download and delete is audit-logged." }, { "name": "Transactions", "description": "Transfers of value between people, businesses and external parties." }, { "name": "Ledger", "description": "Read-only views derived from transactions and asset holdings." }, { "name": "Wireless Networks", "description": "Wi-Fi/Bluetooth/cell observations, WiGLE KML import, and person associations." }, { "name": "Locations", "description": "Aggregated mappable locations across entities." }, { "name": "Geocoding", "description": "Address lookup through the configured geocoding provider." }, { "name": "Search", "description": "Global and advanced search." }, { "name": "Tools", "description": "The OSINT tool catalogue: links, and integrated tools GHOST calls server-side. Central tools are managed by admins and shared with everyone or with selected projects; users may add their own (when an admin allows it), private or shared with their projects. API keys are write-only and never returned." }, { "name": "Integrations", "description": "Installed integration manifests: the JSON definitions behind integrated tools. Built-ins ship with GHOST; admins can install community ones." }, { "name": "Todos", "description": "Investigation task list." }, { "name": "Scratchpad", "description": "The caller's private notepad: markdown notes and panel settings. Not project-scoped, and only ever visible to its owner." }, { "name": "Settings", "description": "Custom fields, model options (taxonomies) and instance configuration." }, { "name": "Users", "description": "User administration and the member-picker directory." }, { "name": "Audit Logs", "description": "Who changed what, and when." }, { "name": "System", "description": "Health, version, the OpenAPI document itself, and whole-database export/import." } ], "components": { "securitySchemes": { "cookieAuth": { "type": "apiKey", "in": "cookie", "name": "connect.sid" } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] }, "ValidationError": { "type": "object", "properties": { "error": { "type": "string", "const": "Validation failed" }, "fields": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "error", "fields" ] }, "PersonCreate": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1, "maxLength": 255 }, "project_id": { "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 } ] }, "lastName": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "patronymic": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "date_of_birth": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dateOfBirth": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "crmStatus": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "caseName": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "profilePictureUrl": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "aliases": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "locations": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "label": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "minimum": -90, "maximum": 90 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } } } }, { "type": "null" } ] }, "connections": { "anyOf": [ { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, { "type": "null" } ] }, "osintData": { "anyOf": [ { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, { "type": "null" } ] }, "attachments": { "anyOf": [ { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, { "type": "null" } ] }, "custom_fields": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "firstName", "project_id" ] }, "PersonUpdate": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1, "maxLength": 255 }, "lastName": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "patronymic": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "date_of_birth": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dateOfBirth": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "crmStatus": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "caseName": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "profilePictureUrl": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "aliases": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "locations": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "label": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "minimum": -90, "maximum": 90 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } } } }, { "type": "null" } ] }, "connections": { "anyOf": [ { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, { "type": "null" } ] }, "osintData": { "anyOf": [ { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, { "type": "null" } ] }, "attachments": { "anyOf": [ { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, { "type": "null" } ] }, "custom_fields": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } } }, "BusinessCreate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "project_id": { "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 } ] }, "type": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "industry": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, { "type": "string", "const": "" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "string", "const": "" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string", "pattern": "^[\\d\\s\\-\\+\\(\\)]+$" }, { "type": "string", "const": "" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "registration_number": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "registration_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "minimum": -90, "maximum": 90 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "owner_person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "owner_business_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "employees": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "is_decision_maker": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "role": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "department": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "required": [ "name" ] } }, { "type": "null" } ] }, "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } }, "required": [ "name", "project_id" ] }, "BusinessUpdate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "type": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "industry": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, { "type": "string", "const": "" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "string", "const": "" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string", "pattern": "^[\\d\\s\\-\\+\\(\\)]+$" }, { "type": "string", "const": "" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "registration_number": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "registration_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "minimum": -90, "maximum": 90 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "owner_person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "owner_business_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "employees": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "is_decision_maker": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "role": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "department": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "required": [ "name" ] } }, { "type": "null" } ] }, "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } }, "required": [ "name" ] }, "ToolCreate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "link": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "string", "const": "" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "tags": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "link", "integration" ] }, "integration_id": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ] }, "visibility": { "type": "string", "enum": [ "all", "projects", "private" ] }, "project_ids": { "maxItems": 500, "type": "array", "items": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "enabled": { "type": "boolean" }, "credential_mode": { "type": "string", "enum": [ "shared", "per_user" ] } }, "required": [ "name" ] }, "ToolUpdate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "link": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "string", "const": "" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "tags": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "link", "integration" ] }, "integration_id": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ] }, "visibility": { "type": "string", "enum": [ "all", "projects", "private" ] }, "project_ids": { "maxItems": 500, "type": "array", "items": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "enabled": { "type": "boolean" }, "credential_mode": { "type": "string", "enum": [ "shared", "per_user" ] } }, "required": [ "name" ] }, "ToolBulkImport": { "type": "object", "properties": { "tools": { "minItems": 1, "maxItems": 2000, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "link": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "tags": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "name" ] } }, "mode": { "default": "skip", "type": "string", "enum": [ "skip", "update" ] } }, "required": [ "tools" ] }, "ToolCredential": { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "shared", "mine" ] }, "secret": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "scope", "secret" ] }, "ToolRun": { "type": "object", "properties": { "operation": { "type": "string", "minLength": 1, "maxLength": 41 }, "input": { "type": "string", "minLength": 1, "maxLength": 2000 }, "person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } }, "required": [ "operation", "input" ] }, "ToolExport": { "type": "object", "properties": { "include_config": { "default": false, "type": "boolean" }, "passphrase": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "tool_ids": { "maxItems": 5000, "type": "array", "items": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } } } }, "ToolFileImport": { "type": "object", "properties": { "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "include_config": { "default": false, "type": "boolean" }, "passphrase": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "mode": { "default": "skip", "type": "string", "enum": [ "skip", "update" ] }, "project_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } }, "required": [ "data" ] }, "IntegrationImport": { "type": "object", "properties": { "manifest": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "replace": { "type": "boolean" } }, "required": [ "manifest" ] }, "IntegrationDraftTest": { "type": "object", "properties": { "manifest": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "operation_id": { "anyOf": [ { "type": "string", "maxLength": 41 }, { "type": "null" } ] }, "input": { "type": "string", "minLength": 1, "maxLength": 2000 }, "secret": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "required": [ "manifest", "input" ] }, "IntegrationDraftMap": { "type": "object", "properties": { "results": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "json": {} }, "required": [ "results", "json" ] }, "SettingsTools": { "type": "object", "properties": { "allow_user_tools": { "type": "boolean" } }, "required": [ "allow_user_tools" ] }, "PersonOsintAppend": { "type": "object", "properties": { "entries": { "minItems": 1, "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "minLength": 1, "maxLength": 100 }, "value": { "type": "string", "minLength": 1, "maxLength": 1000 }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "source": { "type": "object", "properties": { "tool_id": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "tool_name": { "type": "string", "maxLength": 255 }, "integration_id": { "type": "string", "maxLength": 64 }, "operation": { "type": "string", "maxLength": 100 }, "query": { "type": "string", "maxLength": 2000 }, "retrieved_at": { "type": "string", "maxLength": 40 } } } }, "required": [ "type", "value" ] } } }, "required": [ "entries" ] }, "CaseCreate": { "type": "object", "properties": { "case_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "project_id": { "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "enum": [ "active", "on_hold", "closed" ] }, { "type": "null" } ] } }, "required": [ "case_name", "project_id" ] }, "CaseUpdate": { "type": "object", "properties": { "case_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "enum": [ "active", "on_hold", "closed" ] }, { "type": "null" } ] } }, "required": [ "case_name" ] }, "ProjectCreate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "enum": [ "active", "on_hold", "closed" ] }, { "type": "null" } ] }, "allow_cross_linking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "icon": { "anyOf": [ { "type": "string", "maxLength": 8 }, { "type": "null" } ] } }, "required": [ "name" ] }, "ProjectUpdate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "enum": [ "active", "on_hold", "closed" ] }, { "type": "null" } ] }, "allow_cross_linking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "icon": { "anyOf": [ { "type": "string", "maxLength": 8 }, { "type": "null" } ] } }, "required": [ "name" ] }, "ProjectMemberCreate": { "type": "object", "properties": { "user_id": { "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 } ] }, "project_role": { "type": "string", "enum": [ "owner", "manager", "investigator" ] } }, "required": [ "user_id", "project_role" ] }, "ProjectMemberUpdate": { "type": "object", "properties": { "project_role": { "type": "string", "enum": [ "owner", "manager", "investigator" ] } }, "required": [ "project_role" ] }, "RelationshipCreate": { "type": "object", "properties": { "project_id": { "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 } ] }, "source_type": { "type": "string", "enum": [ "person", "business", "crypto_wallet" ] }, "source_id": { "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 } ] }, "target_type": { "type": "string", "enum": [ "person", "business", "crypto_wallet" ] }, "target_id": { "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 } ] }, "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "relationship_type": { "type": "string", "minLength": 1, "maxLength": 100 }, "note": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "required": [ "project_id", "source_type", "source_id", "target_type", "target_id", "relationship_type" ] }, "RelationshipUpdate": { "type": "object", "properties": { "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "relationship_type": { "type": "string", "minLength": 1, "maxLength": 100 }, "note": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "required": [ "relationship_type" ] }, "TodoCreate": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 2000 }, "status": { "default": "open", "anyOf": [ { "type": "string", "enum": [ "open", "in_progress", "on_hold", "attention", "done", "cancelled" ] }, { "type": "null" } ] }, "last_update_comment": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "project_id": { "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 } ] }, "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } }, "required": [ "text", "project_id" ] }, "TodoUpdate": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 2000 }, "status": { "anyOf": [ { "type": "string", "enum": [ "open", "in_progress", "on_hold", "attention", "done", "cancelled" ] }, { "type": "null" } ] }, "last_update_comment": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } } }, "ScratchpadEntryCreate": { "type": "object", "properties": { "content": { "type": "string", "minLength": 1, "maxLength": 20000 }, "source_label": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] } }, "required": [ "content" ] }, "ScratchpadEntryUpdate": { "type": "object", "properties": { "content": { "type": "string", "minLength": 1, "maxLength": 20000 } }, "required": [ "content" ] }, "ScratchpadSettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "showTodos": { "type": "boolean" }, "selectionButton": { "type": "boolean" }, "corner": { "type": "string", "enum": [ "bottom-right", "bottom-left", "top-right", "top-left" ] }, "color": { "type": "string", "enum": [ "default", "amber", "emerald", "sky", "violet", "rose", "slate" ] }, "opacity": { "type": "integer", "minimum": 50, "maximum": 100 }, "fontSize": { "type": "string", "enum": [ "sm", "md", "lg" ] } } }, "TravelHistoryCreate": { "type": "object", "properties": { "location_type": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "location_name": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "minimum": -90, "maximum": 90 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "arrival_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "departure_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "purpose": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "transportation_mode": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } } }, "TravelHistoryUpdate": { "type": "object", "properties": { "location_type": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "location_name": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "minimum": -90, "maximum": 90 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "arrival_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "departure_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "purpose": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "transportation_mode": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } } }, "PropertyCreate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "project_id": { "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 } ] }, "property_type": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "minimum": -90, "maximum": 90 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "owner_person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "area_sqm": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "purchase_value": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } }, "required": [ "name", "project_id" ] }, "PropertyUpdate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "property_type": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "minimum": -90, "maximum": 90 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "owner_person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "area_sqm": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "purchase_value": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } }, "required": [ "name" ] }, "AssetCreate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "initial_holder": { "anyOf": [ { "type": "object", "properties": { "person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "business_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "external": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "occurred_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, { "type": "null" } ] }, "project_id": { "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 } ] }, "category": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "identifier": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "location_mode": { "default": "with_holder", "anyOf": [ { "type": "string", "enum": [ "with_holder", "fixed_known", "fixed_custom", "unknown" ] }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "estimated_value": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string", "maxLength": 10 }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "minimum": -90, "maximum": 90 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "location_name": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "location_person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "location_ref": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ] }, "owner_person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } }, "required": [ "name", "project_id" ] }, "AssetUpdate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "category": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "identifier": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "location_mode": { "default": "with_holder", "anyOf": [ { "type": "string", "enum": [ "with_holder", "fixed_known", "fixed_custom", "unknown" ] }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "estimated_value": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string", "maxLength": 10 }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "minimum": -90, "maximum": 90 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "location_name": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "location_person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "location_ref": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ] }, "owner_person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } }, "required": [ "name" ] }, "CryptoWalletCreate": { "type": "object", "properties": { "address": { "type": "string", "minLength": 1, "maxLength": 255 }, "project_id": { "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 } ] }, "network": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "label": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "tags": { "anyOf": [ { "type": "array", "items": { "type": "string", "maxLength": 100 } }, { "type": "null" } ] }, "external_reference_url": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ] }, "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } }, "required": [ "address", "project_id" ] }, "FileUpdate": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } } }, "CryptoWalletUpdate": { "type": "object", "properties": { "address": { "type": "string", "minLength": 1, "maxLength": 255 }, "network": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "label": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "tags": { "anyOf": [ { "type": "array", "items": { "type": "string", "maxLength": 100 } }, { "type": "null" } ] }, "external_reference_url": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "maxLength": 50 }, { "type": "null" } ] }, "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } }, "required": [ "address" ] }, "TransactionCreate": { "type": "object", "properties": { "transaction_type": { "type": "string", "minLength": 1 }, "occurred_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string", "maxLength": 10 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "tags": { "anyOf": [ { "type": "array", "items": { "type": "string", "maxLength": 100 } }, { "type": "null" } ] }, "item_label": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "item_category": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "from_person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "to_person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "from_business_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "to_business_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "from_wallet_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "to_wallet_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "tx_hash": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "from_external": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "to_external": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "subject_asset_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "subject_business_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "subject_property_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "location_business_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "location_property_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "location_name": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "location_address": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "location_city": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "location_country": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "location_latitude": { "anyOf": [ { "type": "number", "minimum": -90, "maximum": 90 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "location_longitude": { "anyOf": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "minimum": -90, "maximum": 90 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "project_id": { "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 } ] } }, "required": [ "transaction_type", "project_id" ], "description": "Party rules: at most one of from_person_id, from_business_id, from_wallet_id, from_external may be set as the giver; at most one of to_person_id, to_business_id, to_wallet_id, to_external may be set as the receiver; at most one of subject_asset_id, subject_business_id, subject_property_id may be set as the referenced subject; at most one of location_business_id, location_property_id may be set as the event location reference. At least one party (from_* or to_*) is required. Explicit null or empty-string values count as unset. Violations return 400 naming the conflicting fields.", "x-mutually-exclusive": [ { "role": "giver", "fields": [ "from_person_id", "from_business_id", "from_wallet_id", "from_external" ] }, { "role": "receiver", "fields": [ "to_person_id", "to_business_id", "to_wallet_id", "to_external" ] }, { "role": "referenced subject", "fields": [ "subject_asset_id", "subject_business_id", "subject_property_id" ] }, { "role": "event location reference", "fields": [ "location_business_id", "location_property_id" ] } ] }, "TransactionUpdate": { "type": "object", "properties": { "transaction_type": { "type": "string", "minLength": 1 }, "occurred_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string", "maxLength": 10 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "tags": { "anyOf": [ { "type": "array", "items": { "type": "string", "maxLength": 100 } }, { "type": "null" } ] }, "item_label": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "item_category": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "from_person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "to_person_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "from_business_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "to_business_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "from_wallet_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "to_wallet_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "tx_hash": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "from_external": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "to_external": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "subject_asset_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "subject_business_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "subject_property_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "location_business_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "location_property_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "location_name": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "location_address": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "location_city": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "location_country": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "location_latitude": { "anyOf": [ { "type": "number", "minimum": -90, "maximum": 90 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "location_longitude": { "anyOf": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "minimum": -90, "maximum": 90 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] }, "case_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } }, "required": [ "transaction_type" ], "description": "Party rules: at most one of from_person_id, from_business_id, from_wallet_id, from_external may be set as the giver; at most one of to_person_id, to_business_id, to_wallet_id, to_external may be set as the receiver; at most one of subject_asset_id, subject_business_id, subject_property_id may be set as the referenced subject; at most one of location_business_id, location_property_id may be set as the event location reference. At least one party (from_* or to_*) is required. Explicit null or empty-string values count as unset. Violations return 400 naming the conflicting fields.", "x-mutually-exclusive": [ { "role": "giver", "fields": [ "from_person_id", "from_business_id", "from_wallet_id", "from_external" ] }, { "role": "receiver", "fields": [ "to_person_id", "to_business_id", "to_wallet_id", "to_external" ] }, { "role": "referenced subject", "fields": [ "subject_asset_id", "subject_business_id", "subject_property_id" ] }, { "role": "event location reference", "fields": [ "location_business_id", "location_property_id" ] } ] }, "SettingsCustomFieldCreate": { "type": "object", "properties": { "field_name": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[a-zA-Z0-9_]+$" }, "field_label": { "type": "string", "minLength": 1, "maxLength": 255 }, "field_type": { "type": "string", "enum": [ "text", "number", "date", "boolean", "select" ] }, "options": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "field_name", "field_label", "field_type" ] }, "SettingsCustomFieldUpdate": { "type": "object", "properties": { "field_label": { "type": "string", "minLength": 1, "maxLength": 255 }, "field_type": { "type": "string", "enum": [ "text", "number", "date", "boolean", "select" ] }, "options": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "field_label", "field_type" ] }, "SettingsModelOptionCreate": { "type": "object", "properties": { "model_type": { "type": "string", "minLength": 1, "maxLength": 100 }, "option_value": { "type": "string", "minLength": 1, "maxLength": 255 }, "option_label": { "type": "string", "minLength": 1, "maxLength": 255 }, "display_order": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } }, "required": [ "model_type", "option_value", "option_label" ] }, "SettingsModelOptionUpdate": { "type": "object", "properties": { "option_label": { "type": "string", "maxLength": 255 }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "display_order": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "string", "minLength": 1 }, { "type": "string", "const": "" }, { "type": "null" } ] } } }, "SettingsBrandingUpdate": { "type": "object", "properties": { "appName": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ] }, "appLogo": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "defaultLanguage": { "anyOf": [ { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, { "type": "null" } ] }, "defaultThemeMode": { "type": "string", "enum": [ "light", "dark", "system" ] } } }, "SettingsGeocodingUpdate": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "nominatim", "yandex", "locationiq" ] }, "apiKeys": { "type": "object", "properties": { "nominatim": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "yandex": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "locationiq": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] } } } } }, "SettingsUpdateCheck": { "type": "object", "properties": { "updateCheckEnabled": { "type": "boolean" } }, "required": [ "updateCheckEnabled" ] }, "SettingsProjectRetention": { "type": "object", "properties": { "retentionDays": { "type": "integer", "minimum": 0, "maximum": 3650 } }, "required": [ "retentionDays" ] } } }, "paths": { "/auth/login": { "post": { "tags": [ "Auth" ], "summary": "Log in and receive a session cookie", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "username", "password" ] } } } }, "responses": { "200": { "description": "Logged in; session cookie set", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (default 10 attempts / 15 min)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auth/logout": { "post": { "tags": [ "Auth" ], "summary": "Log out and destroy the session", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/auth/session": { "get": { "tags": [ "Auth" ], "summary": "Check current session state", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/auth/me": { "get": { "tags": [ "Auth" ], "summary": "Get the current user profile", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "tags": [ "Auth" ], "summary": "Update the current user profile", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/people": { "get": { "tags": [ "People" ], "summary": "List People", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } }, { "name": "case_id", "in": "query", "description": "Filter by case", "schema": { "type": "integer" } } ], "description": "MCP tool: `ghost_get_people`" }, "post": { "tags": [ "People" ], "summary": "Create a people", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonCreate" } } } }, "description": "MCP tool: `ghost_create_people`" } }, "/people/{id}": { "get": { "tags": [ "People" ], "summary": "Get one by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_get_people_by_id`" }, "put": { "tags": [ "People" ], "summary": "Update by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonUpdate" } } } }, "description": "MCP tool: `ghost_update_people`" }, "delete": { "tags": [ "People" ], "summary": "Delete by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_delete_people`" } }, "/people/{id}/osint": { "post": { "tags": [ "People" ], "summary": "Add OSINT data entries to a person", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Appends entries (skipping ones the person already has). Entries with a source are marked unverified and keep where they came from.\n\nMCP tool: `ghost_create_people_osint`", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonOsintAppend" } } } } } }, "/people/{id}/locations": { "post": { "tags": [ "People" ], "summary": "Add a location to a person", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "description": "MCP tool: `ghost_create_people_locations`" } }, "/people/{id}/locations/{index}": { "put": { "tags": [ "People" ], "summary": "Update a person location by array index", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 0 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "description": "MCP tool: `ghost_update_people_locations`" }, "delete": { "tags": [ "People" ], "summary": "Remove a person location by array index", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 0 } } ], "description": "MCP tool: `ghost_delete_people_locations`" } }, "/people/{id}/travel-history": { "get": { "tags": [ "Travel History" ], "summary": "List travel history for a person", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_get_people_travel_history`" }, "post": { "tags": [ "Travel History" ], "summary": "Add a travel history entry", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelHistoryCreate" } } } }, "description": "MCP tool: `ghost_create_people_travel_history`" } }, "/people/{id}/travel-analysis": { "get": { "tags": [ "Travel History" ], "summary": "Travel pattern analysis for a person", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_get_people_travel_analysis`" } }, "/travel-history/{id}": { "put": { "tags": [ "Travel History" ], "summary": "Update a travel history entry", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelHistoryUpdate" } } } }, "description": "MCP tool: `ghost_update_travel_history`" }, "delete": { "tags": [ "Travel History" ], "summary": "Delete a travel history entry", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_delete_travel_history`" } }, "/people/{id}/transactions": { "get": { "tags": [ "Ledger" ], "summary": "Transactions a person appears in", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_get_people_transactions`" } }, "/people/{id}/assets": { "get": { "tags": [ "Ledger" ], "summary": "Assets currently held by a person", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_get_people_assets`" } }, "/businesses": { "get": { "tags": [ "Businesses" ], "summary": "List Businesses", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } }, { "name": "case_id", "in": "query", "description": "Filter by case", "schema": { "type": "integer" } } ], "description": "MCP tool: `ghost_get_businesses`" }, "post": { "tags": [ "Businesses" ], "summary": "Create a businesse", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessCreate" } } } }, "description": "MCP tool: `ghost_create_businesses`" } }, "/businesses/{id}": { "get": { "tags": [ "Businesses" ], "summary": "Get one by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_get_businesses_by_id`" }, "put": { "tags": [ "Businesses" ], "summary": "Update by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessUpdate" } } } }, "description": "MCP tool: `ghost_update_businesses`" }, "delete": { "tags": [ "Businesses" ], "summary": "Delete by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_delete_businesses`" } }, "/businesses/{id}/transactions": { "get": { "tags": [ "Ledger" ], "summary": "Transactions a business appears in", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_get_businesses_transactions`" } }, "/businesses/{id}/venue-stats": { "get": { "tags": [ "Ledger" ], "summary": "Venue analytics: distinct visitors and ranked people", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_get_businesses_venue_stats`" } }, "/tools": { "get": { "tags": [ "Tools" ], "summary": "List Tools", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } }, { "name": "all", "in": "query", "description": "Admins only: \"true\" lists every tool, including users' private ones", "schema": { "type": "string" } } ], "description": "MCP tool: `ghost_get_tools`" }, "post": { "tags": [ "Tools" ], "summary": "Create a tool", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolCreate" } } } }, "description": "MCP tool: `ghost_create_tools`" } }, "/tools/{id}": { "put": { "tags": [ "Tools" ], "summary": "Update by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolUpdate" } } } }, "description": "MCP tool: `ghost_update_tools`" }, "delete": { "tags": [ "Tools" ], "summary": "Delete by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_delete_tools`" } }, "/tools/{id}/credentials": { "put": { "tags": [ "Tools" ], "summary": "Set an API key for an integrated tool", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "scope \"shared\" sets the key everyone uses (needs the right to manage the tool); scope \"mine\" sets the caller's own key for tools using per-user keys. Keys are stored encrypted and never returned.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolCredential" } } } }, "x-mcp-exclude": true }, "delete": { "tags": [ "Tools" ], "summary": "Remove an API key", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "scope", "in": "query", "description": "\"shared\" (default) or \"mine\"", "schema": { "type": "string" } } ], "x-mcp-exclude": true } }, "/tools/{id}/run": { "post": { "tags": [ "Tools" ], "summary": "Search with an integrated tool", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Calls the integration server-side and returns its results mapped into fields. With person_id the tool must be available in that person's project. Rate-limited, audit-logged.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolRun" } } } }, "x-mcp-exclude": true } }, "/tools/{id}/test": { "post": { "tags": [ "Tools" ], "summary": "Test an integrated tool's connection and key", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "x-mcp-exclude": true } }, "/tools/export": { "post": { "tags": [ "Tools" ], "summary": "Export the tool list", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "include_config adds sharing settings for tools the caller manages; with a passphrase (8+ characters) their shared API keys are included, encrypted with it.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolExport" } } } }, "x-mcp-exclude": true } }, "/tools/import": { "post": { "tags": [ "Tools" ], "summary": "Import a tool list exported by GHOST", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Admins import central tools, other users their own. include_config applies the file's sharing settings (projects matched by name) and, with the passphrase, its API keys. project_id assigns every tool to that project instead.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolFileImport" } } } }, "x-mcp-exclude": true } }, "/tools/bulk-import": { "post": { "tags": [ "Tools" ], "summary": "Import many OSINT tools in one request", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Duplicates are matched on name, case-insensitively. mode=\"skip\" (the default) leaves existing tools untouched; mode=\"update\" overwrites only the fields each row supplies, so a partial row cannot blank out a tool's other values. Rows are processed individually — one bad row does not abort the rest — and the response reports created/updated/skipped counts plus per-row errors. Prefer this over calling the single-tool create repeatedly: it is one request and is not subject to the per-request rate limit.\n\nMCP tool: `ghost_create_tools_bulk_import`", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolBulkImport" } } } } } }, "/todos": { "get": { "tags": [ "Todos" ], "summary": "List Todos", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } }, { "name": "case_id", "in": "query", "description": "Filter by case", "schema": { "type": "integer" } } ], "description": "MCP tool: `ghost_get_todos`" }, "post": { "tags": [ "Todos" ], "summary": "Create a todo", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TodoCreate" } } } }, "description": "MCP tool: `ghost_create_todos`" } }, "/todos/{id}": { "put": { "tags": [ "Todos" ], "summary": "Update by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TodoUpdate" } } } }, "description": "MCP tool: `ghost_update_todos`" }, "delete": { "tags": [ "Todos" ], "summary": "Delete by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_delete_todos`" } }, "/scratchpad": { "get": { "tags": [ "Scratchpad" ], "summary": "Get the caller's notes and scratchpad settings", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mcp-exclude": true } }, "/scratchpad/entries": { "post": { "tags": [ "Scratchpad" ], "summary": "Add a note", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScratchpadEntryCreate" } } } }, "x-mcp-exclude": true }, "delete": { "tags": [ "Scratchpad" ], "summary": "Clear every note", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "up_to_id", "in": "query", "description": "Only clear notes with an id up to and including this one", "schema": { "type": "integer" } } ], "x-mcp-exclude": true } }, "/scratchpad/entries/{id}": { "put": { "tags": [ "Scratchpad" ], "summary": "Edit a note", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScratchpadEntryUpdate" } } } }, "x-mcp-exclude": true }, "delete": { "tags": [ "Scratchpad" ], "summary": "Delete a note", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "x-mcp-exclude": true } }, "/scratchpad/settings": { "put": { "tags": [ "Scratchpad" ], "summary": "Update scratchpad settings (only the keys sent change)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScratchpadSettings" } } } }, "x-mcp-exclude": true } }, "/cases": { "get": { "tags": [ "Cases" ], "summary": "List Cases", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } } ], "description": "MCP tool: `ghost_get_cases`" }, "post": { "tags": [ "Cases" ], "summary": "Create a case", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseCreate" } } } }, "description": "MCP tool: `ghost_create_cases`" } }, "/cases/{id}": { "put": { "tags": [ "Cases" ], "summary": "Update by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseUpdate" } } } }, "description": "MCP tool: `ghost_update_cases`" }, "delete": { "tags": [ "Cases" ], "summary": "Delete by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_delete_cases`" } }, "/projects": { "get": { "tags": [ "Projects" ], "summary": "List Projects", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [], "description": "MCP tool: `ghost_get_projects`" }, "post": { "tags": [ "Projects" ], "summary": "Create a project", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreate" } } } }, "x-requires-admin": true, "description": "**Admin only.** MCP tool: `ghost_create_projects`" } }, "/projects/{id}": { "put": { "tags": [ "Projects" ], "summary": "Update by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdate" } } } }, "description": "MCP tool: `ghost_update_projects`" }, "delete": { "tags": [ "Projects" ], "summary": "Delete by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Removes the project and every project-scoped record in it. GET /projects/{id}/stats shows what would be destroyed.\n\n**Admin only.** MCP tool: `ghost_delete_projects`", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "confirm_name", "in": "query", "description": "The project name, echoed back. Required when the project still contains data.", "schema": { "type": "string" } } ], "x-requires-admin": true } }, "/projects/{id}/stats": { "get": { "tags": [ "Projects" ], "summary": "Per-entity row counts for a project", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Powers the delete-confirmation dialog. DELETE /projects/{id} requires the project name echoed back in a \"confirm_name\" body field when the project still contains data, and then removes every project-scoped entity along with the project.\n\nMCP tool: `ghost_get_projects_stats`", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] } }, "/projects/{id}/members": { "get": { "tags": [ "Projects" ], "summary": "List the members of a project", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Any member of the project (or an admin) may read the list.\n\nMCP tool: `ghost_get_projects_members`", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] }, "post": { "tags": [ "Projects" ], "summary": "Add a user to a project", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Member added", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not an owner or manager of this project, or the change is above their role", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Already a member", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Requires the owner or manager role on the project, or admin. Only an admin may add an owner; only an owner or admin may add a manager. Returns 409 if the user is already a member.\n\nMCP tool: `ghost_create_projects_members`", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMemberCreate" } } } } } }, "/projects/{id}/members/{userId}": { "put": { "tags": [ "Projects" ], "summary": "Change a member's project role", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not an owner or manager of this project, or the change is above their role", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Requires the owner or manager role on the project, or admin. Roles rank owner > manager > investigator: a non-admin may only change members ranked below themselves, may only grant roles below their own, and may not change their own membership.\n\nMCP tool: `ghost_update_projects_members`", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMemberUpdate" } } } } }, "delete": { "tags": [ "Projects" ], "summary": "Remove a member from a project", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Not an owner or manager of this project, or the change is above their role", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Requires the owner or manager role on the project, or admin. A non-admin may only remove members ranked below themselves (owner > manager > investigator), and may not remove themselves.\n\nMCP tool: `ghost_delete_projects_members`", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] } }, "/properties": { "get": { "tags": [ "Properties" ], "summary": "List Properties", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" } } } } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } }, { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } }, { "name": "property_type", "in": "query", "description": "Filter by property type", "schema": { "type": "string" } }, { "name": "case_id", "in": "query", "description": "Filter by case", "schema": { "type": "integer" } }, { "name": "owner_person_id", "in": "query", "description": "Filter by owner", "schema": { "type": "integer" } }, { "name": "q", "in": "query", "description": "Search name/address/city", "schema": { "type": "string" } }, { "name": "bbox", "in": "query", "description": "Map bounds filter: west,south,east,north", "schema": { "type": "string" } } ], "description": "MCP tool: `ghost_get_properties`" }, "post": { "tags": [ "Properties" ], "summary": "Create a propertie", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyCreate" } } } }, "description": "MCP tool: `ghost_create_properties`" } }, "/properties/{id}": { "get": { "tags": [ "Properties" ], "summary": "Get one by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_get_properties_by_id`" }, "put": { "tags": [ "Properties" ], "summary": "Update by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyUpdate" } } } }, "description": "MCP tool: `ghost_update_properties`" }, "delete": { "tags": [ "Properties" ], "summary": "Delete by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_delete_properties`" } }, "/properties/{id}/transactions": { "get": { "tags": [ "Ledger" ], "summary": "Transactions a property appears in", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_get_properties_transactions`" } }, "/assets": { "get": { "tags": [ "Assets" ], "summary": "List Assets", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" } } } } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } }, { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } }, { "name": "category", "in": "query", "description": "Filter by category (an asset_category model option)", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by status", "schema": { "type": "string" } }, { "name": "case_id", "in": "query", "description": "Filter by case", "schema": { "type": "integer" } }, { "name": "q", "in": "query", "description": "Search name/identifier", "schema": { "type": "string" } }, { "name": "holder_person_id", "in": "query", "description": "Assets currently held by this person", "schema": { "type": "integer" } }, { "name": "bbox", "in": "query", "description": "Map bounds filter: west,south,east,north", "schema": { "type": "string" } } ], "description": "MCP tool: `ghost_get_assets`" }, "post": { "tags": [ "Assets" ], "summary": "Create a asset", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetCreate" } } } }, "description": "MCP tool: `ghost_create_assets`" } }, "/assets/{id}": { "get": { "tags": [ "Assets" ], "summary": "Get one by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_get_assets_by_id`" }, "put": { "tags": [ "Assets" ], "summary": "Update by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetUpdate" } } } }, "description": "MCP tool: `ghost_update_assets`" }, "delete": { "tags": [ "Assets" ], "summary": "Delete by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_delete_assets`" } }, "/crypto-wallets": { "get": { "tags": [ "Crypto Wallets" ], "summary": "List Crypto Wallets", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" } } } } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } }, { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } }, { "name": "network", "in": "query", "description": "Filter by network (a crypto_wallet_network model option)", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by status", "schema": { "type": "string" } }, { "name": "case_id", "in": "query", "description": "Filter by case", "schema": { "type": "integer" } }, { "name": "q", "in": "query", "description": "Search address/label", "schema": { "type": "string" } }, { "name": "tag", "in": "query", "description": "Wallets carrying this exact tag", "schema": { "type": "string" } } ], "description": "MCP tool: `ghost_get_crypto_wallets`" }, "post": { "tags": [ "Crypto Wallets" ], "summary": "Create a crypto wallet", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CryptoWalletCreate" } } } }, "description": "MCP tool: `ghost_create_crypto_wallets`" } }, "/crypto-wallets/{id}": { "get": { "tags": [ "Crypto Wallets" ], "summary": "Get one by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_get_crypto_wallets_by_id`" }, "put": { "tags": [ "Crypto Wallets" ], "summary": "Update by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CryptoWalletUpdate" } } } }, "description": "MCP tool: `ghost_update_crypto_wallets`" }, "delete": { "tags": [ "Crypto Wallets" ], "summary": "Delete by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_delete_crypto_wallets`" } }, "/files": { "get": { "tags": [ "Files" ], "summary": "List files", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" } } } } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Newest first. Returns metadata only; fetch the bytes from /files/{id}/content.\n\nMCP tool: `ghost_get_files`", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } }, { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } }, { "name": "person_id", "in": "query", "description": "Only files attached to this person", "schema": { "type": "integer" } }, { "name": "uploaded_by", "in": "query", "description": "Only files uploaded by this user", "schema": { "type": "integer" } }, { "name": "q", "in": "query", "description": "Search file name and description", "schema": { "type": "string" } } ] }, "post": { "tags": [ "Files" ], "summary": "Upload a file", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Uploaded", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "File exceeds the size limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Send project_id for a project-level file, or person_id to attach it to a person (the project then comes from the person). Upload limit is FILES_MAX_BYTES (default 50 MB); larger files return 413. The SHA-256 of the stored bytes is returned as `sha256`.", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "project_id": { "type": "integer" }, "person_id": { "type": "integer" }, "description": { "type": "string", "maxLength": 2000 } }, "required": [ "file" ] } } } }, "x-mcp-exclude": true } }, "/files/{id}": { "get": { "tags": [ "Files" ], "summary": "Get file metadata", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_get_files_by_id`" }, "put": { "tags": [ "Files" ], "summary": "Edit a file's description or person", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Only the fields sent change. person_id: null moves the file to project level.\n\nMCP tool: `ghost_update_files`", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUpdate" } } } } }, "delete": { "tags": [ "Files" ], "summary": "Delete a file", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Allowed for the uploader, the project's owners and managers, and admins.\n\nMCP tool: `ghost_delete_files`", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ] } }, "/files/{id}/content": { "get": { "tags": [ "Files" ], "summary": "Download a file", "responses": { "200": { "description": "The file", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "The stored file is missing from disk", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Always sent as an attachment with Content-Type application/octet-stream.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "preview", "in": "query", "description": "Send 1 when the bytes are for an in-app preview; logged as a view instead of a download.", "schema": { "type": "string" } } ], "x-mcp-exclude": true } }, "/transactions": { "get": { "tags": [ "Transactions" ], "summary": "List Transactions", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" } } } } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } }, { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } }, { "name": "transaction_type", "in": "query", "description": "Filter by type (a transaction_type model option)", "schema": { "type": "string" } }, { "name": "item_category", "in": "query", "description": "Filter by item category", "schema": { "type": "string" } }, { "name": "person_id", "in": "query", "description": "Transactions where the person is giver or receiver", "schema": { "type": "integer" } }, { "name": "from_person_id", "in": "query", "description": "Filter by giver", "schema": { "type": "integer" } }, { "name": "to_person_id", "in": "query", "description": "Filter by receiver", "schema": { "type": "integer" } }, { "name": "business_id", "in": "query", "description": "Transactions where the business is giver, receiver, subject or venue", "schema": { "type": "integer" } }, { "name": "wallet_id", "in": "query", "description": "Transactions where the crypto wallet is sender or receiver", "schema": { "type": "integer" } }, { "name": "tx_hash", "in": "query", "description": "Exact on-chain transaction hash", "schema": { "type": "string" } }, { "name": "subject_asset_id", "in": "query", "description": "Filter by the asset the transaction is about", "schema": { "type": "integer" } }, { "name": "subject_business_id", "in": "query", "description": "Filter by the business the transaction is about", "schema": { "type": "integer" } }, { "name": "subject_property_id", "in": "query", "description": "Filter by the property the transaction is about", "schema": { "type": "integer" } }, { "name": "location_business_id", "in": "query", "description": "Filter by venue (business)", "schema": { "type": "integer" } }, { "name": "location_property_id", "in": "query", "description": "Filter by venue (property)", "schema": { "type": "integer" } }, { "name": "case_id", "in": "query", "description": "Filter by case", "schema": { "type": "integer" } }, { "name": "date_from", "in": "query", "description": "Only transactions that occurred on or after this date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "description": "Only transactions that occurred on or before this date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "bbox", "in": "query", "description": "Map bounds filter: west,south,east,north", "schema": { "type": "string" } } ], "description": "MCP tool: `ghost_get_transactions`" }, "post": { "tags": [ "Transactions" ], "summary": "Create a transaction", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionCreate" } } } }, "description": "MCP tool: `ghost_create_transactions`" } }, "/transactions/{id}": { "get": { "tags": [ "Transactions" ], "summary": "Get one by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_get_transactions_by_id`" }, "put": { "tags": [ "Transactions" ], "summary": "Update by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionUpdate" } } } }, "description": "MCP tool: `ghost_update_transactions`" }, "delete": { "tags": [ "Transactions" ], "summary": "Delete by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_delete_transactions`" } }, "/{entityType}/{id}/ledger": { "get": { "tags": [ "Ledger" ], "summary": "Unified chronological ledger for an entity", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Every transaction the entity appears in (as giver, receiver, subject, or venue) with value-in/value-out/net per currency and current holdings.\n\nMCP tool: `ghost_get_ledger`", "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "people", "businesses", "properties" ] } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "case_id", "in": "query", "description": "Filter by case", "schema": { "type": "integer" } }, { "name": "date_from", "in": "query", "description": "Only transactions that occurred on or after this date (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "description": "Only transactions that occurred on or before this date (YYYY-MM-DD)", "schema": { "type": "string" } } ] } }, "/search": { "get": { "tags": [ "Search" ], "summary": "Global search across entities", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "q", "in": "query", "description": "Search term", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } } ], "description": "MCP tool: `ghost_get_search`" } }, "/search/advanced": { "get": { "tags": [ "Search" ], "summary": "Advanced multi-filter search over people", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "searchText", "in": "query", "description": "Text to look for", "schema": { "type": "string" } }, { "name": "searchIn[]", "in": "query", "description": "Fields searchText is matched against. Defaults to name.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "aliases", "notes" ] } } }, { "name": "categories[]", "in": "query", "description": "Only people in one of these categories", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "statuses[]", "in": "query", "description": "Only people with one of these statuses", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "dateFilter", "in": "query", "description": "Which timestamp dateFrom/dateTo apply to. Defaults to updated; all ignores the dates.", "schema": { "type": "string", "enum": [ "updated", "created", "all" ] } }, { "name": "dateFrom", "in": "query", "description": "Earliest timestamp (inclusive)", "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "description": "Latest timestamp (inclusive)", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Sort column", "schema": { "type": "string", "default": "updated_at", "enum": [ "updated_at", "created_at", "first_name", "last_name", "status", "category" ] } }, { "name": "sortOrder", "in": "query", "description": "Sort direction", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "limit", "in": "query", "description": "Maximum rows", "schema": { "type": "integer", "default": 100, "maximum": 500 } }, { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } } ], "description": "MCP tool: `ghost_get_search_advanced`" } }, "/locations": { "get": { "tags": [ "Locations" ], "summary": "All mappable locations across entities", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } }, { "name": "case_id", "in": "query", "description": "Filter by case", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Maximum people returned", "schema": { "type": "integer", "default": 100 } }, { "name": "offset", "in": "query", "description": "People to skip", "schema": { "type": "integer", "default": 0 } }, { "name": "bbox", "in": "query", "description": "Map bounds filter: minLng,minLat,maxLng,maxLat", "schema": { "type": "string" } }, { "name": "confidence", "in": "query", "description": "Minimum geocode confidence, 0-100", "schema": { "type": "integer", "default": 30 } }, { "name": "includeUngeocoded", "in": "query", "description": "Send true to also return people whose locations have no coordinates", "schema": { "type": "string", "enum": [ "true" ] } } ], "description": "MCP tool: `ghost_get_locations`" } }, "/geocode": { "get": { "tags": [ "Geocoding" ], "summary": "Geocode one address to coordinates", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Returns { lat, lng }. A miss returns 404 with a structured reason: not_found, low_confidence, timeout or service_error.\n\nMCP tool: `ghost_get_geocode`", "parameters": [ { "name": "q", "in": "query", "description": "Address to geocode (at least 3 characters)", "schema": { "type": "string" }, "required": true } ] } }, "/geocode/batch": { "post": { "tags": [ "Geocoding" ], "summary": "Geocode every person location that is missing coordinates (legacy)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-requires-admin": true, "x-mcp-exclude": true, "description": "**Admin only.**" } }, "/geocode/batch-enhanced": { "post": { "tags": [ "Geocoding" ], "summary": "Geocode a supplied list of locations and write the results back", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locations": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "minConfidence": { "type": "number", "default": 30 }, "maxConcurrent": { "type": "integer", "default": 3 } }, "required": [ "locations" ] } } } }, "x-requires-admin": true, "x-mcp-exclude": true, "description": "**Admin only.**" } }, "/geocode/suggestions": { "get": { "tags": [ "Geocoding" ], "summary": "Address autocomplete suggestions (rate limited: 60/min)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "q", "in": "query", "description": "Partial address (at least 3 characters)", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum suggestions", "schema": { "type": "integer", "default": 5 } } ], "description": "MCP tool: `ghost_get_geocode_suggestions`" } }, "/geocode/address": { "post": { "tags": [ "Geocoding" ], "summary": "Geocode a single address (rate limited: 60/min)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string" } }, "required": [ "address" ] } } } }, "description": "MCP tool: `ghost_create_geocode_address`" } }, "/geocode/stats": { "get": { "tags": [ "Geocoding" ], "summary": "Geocoding coverage statistics", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "MCP tool: `ghost_get_geocode_stats`" } }, "/relationships": { "get": { "tags": [ "Relationships" ], "summary": "List Relationships", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "source_type", "in": "query", "description": "Filter by source entity type (person|business)", "schema": { "type": "string" } }, { "name": "source_id", "in": "query", "description": "Filter by source entity id", "schema": { "type": "integer" } }, { "name": "target_type", "in": "query", "description": "Filter by target entity type (person|business)", "schema": { "type": "string" } }, { "name": "target_id", "in": "query", "description": "Filter by target entity id", "schema": { "type": "integer" } }, { "name": "project_id", "in": "query", "description": "Filter by project", "schema": { "type": "integer" } }, { "name": "case_id", "in": "query", "description": "Filter by case", "schema": { "type": "integer" } } ], "description": "MCP tool: `ghost_get_relationships`" }, "post": { "tags": [ "Relationships" ], "summary": "Create a relationship", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationshipCreate" } } } }, "description": "MCP tool: `ghost_create_relationships`" } }, "/relationships/{id}": { "put": { "tags": [ "Relationships" ], "summary": "Update by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationshipUpdate" } } } }, "description": "MCP tool: `ghost_update_relationships`" }, "delete": { "tags": [ "Relationships" ], "summary": "Delete by ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_delete_relationships`" } }, "/wireless-networks": { "get": { "tags": [ "Wireless Networks" ], "summary": "List wireless networks with filters", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } }, { "name": "case_id", "in": "query", "description": "Filter by case", "schema": { "type": "integer" } }, { "name": "person_id", "in": "query", "description": "Networks associated with this person", "schema": { "type": "integer" } }, { "name": "ssid", "in": "query", "description": "Filter by SSID", "schema": { "type": "string" } }, { "name": "bssid", "in": "query", "description": "Filter by BSSID", "schema": { "type": "string" } }, { "name": "network_type", "in": "query", "description": "Filter by network type", "schema": { "type": "string" } }, { "name": "encryption", "in": "query", "description": "Filter by encryption", "schema": { "type": "string" } }, { "name": "import_source", "in": "query", "description": "Filter by the file the network was imported from", "schema": { "type": "string" } }, { "name": "signal_min", "in": "query", "description": "Minimum signal strength (dBm)", "schema": { "type": "number" } }, { "name": "signal_max", "in": "query", "description": "Maximum signal strength (dBm)", "schema": { "type": "number" } } ], "description": "MCP tool: `ghost_get_wireless_networks`" }, "post": { "tags": [ "Wireless Networks" ], "summary": "Create a wireless network", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "description": "MCP tool: `ghost_create_wireless_networks`" } }, "/wireless-networks/{id}": { "get": { "tags": [ "Wireless Networks" ], "summary": "Get a wireless network", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_get_wireless_networks_by_id`" }, "put": { "tags": [ "Wireless Networks" ], "summary": "Update a wireless network", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "description": "MCP tool: `ghost_update_wireless_networks`" }, "delete": { "tags": [ "Wireless Networks" ], "summary": "Delete a wireless network", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "description": "MCP tool: `ghost_delete_wireless_networks`" } }, "/wireless-networks/stats": { "get": { "tags": [ "Wireless Networks" ], "summary": "Wireless network statistics", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } } ], "description": "MCP tool: `ghost_get_wireless_networks_stats`" } }, "/wireless-networks/nearby": { "get": { "tags": [ "Wireless Networks" ], "summary": "Networks observed near a point", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "latitude", "in": "query", "description": "Latitude, -90 to 90", "schema": { "type": "number" }, "required": true }, { "name": "longitude", "in": "query", "description": "Longitude, -180 to 180", "schema": { "type": "number" }, "required": true }, { "name": "radius", "in": "query", "description": "Search radius in kilometres", "schema": { "type": "number", "default": 0.5 } }, { "name": "project_id", "in": "query", "description": "Restrict to one project. Non-admins must be a member of it (403 otherwise); when omitted they see every project they belong to, admins see all projects.", "schema": { "type": "integer" } } ], "description": "MCP tool: `ghost_get_wireless_networks_nearby`" } }, "/wireless-networks/bulk-delete": { "post": { "tags": [ "Wireless Networks" ], "summary": "Delete many wireless networks in one request", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "minItems": 1 }, "project_id": { "type": "integer", "description": "When given, only networks in this project are deleted." } }, "required": [ "ids" ] } } } }, "x-requires-admin": true, "x-mcp-exclude": true, "description": "**Admin only.**" } }, "/wireless-networks/import-kml": { "post": { "tags": [ "Wireless Networks" ], "summary": "Import a WiGLE KML export", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "KML file exceeds the size limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Upload limit is KML_MAX_BYTES (default 5 MB); larger files return 413.", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "kmlFile": { "type": "string", "format": "binary" }, "project_id": { "type": "integer", "description": "Project the imported networks land in." } }, "required": [ "kmlFile", "project_id" ] } } } }, "x-mcp-exclude": true } }, "/wireless-networks/{id}/associate": { "post": { "tags": [ "Wireless Networks" ], "summary": "Associate a network with a person or business", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "One of person_id or business_id is required.", "properties": { "person_id": { "type": "integer" }, "business_id": { "type": "integer" }, "association_note": { "type": "string" }, "association_confidence": { "type": "string" } } } } } }, "description": "MCP tool: `ghost_create_wireless_networks_associate`" }, "delete": { "tags": [ "Wireless Networks" ], "summary": "Remove an association from a network", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Removes the named person or business. With neither given, every association on the network is cleared.\n\nMCP tool: `ghost_delete_wireless_networks_associate`", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "person_id": { "type": "integer" }, "business_id": { "type": "integer" } } } } } } } }, "/settings/custom-fields": { "get": { "tags": [ "Settings" ], "summary": "List custom field definitions", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "MCP tool: `ghost_get_settings_custom_fields`" }, "post": { "tags": [ "Settings" ], "summary": "Create a custom field", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsCustomFieldCreate" } } } }, "x-requires-admin": true, "description": "**Admin only.** MCP tool: `ghost_create_settings_custom_fields`" } }, "/settings/custom-fields/{id}": { "put": { "tags": [ "Settings" ], "summary": "Update a custom field", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsCustomFieldUpdate" } } } }, "x-requires-admin": true, "description": "**Admin only.** MCP tool: `ghost_update_settings_custom_fields`" }, "delete": { "tags": [ "Settings" ], "summary": "Delete a custom field", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "x-requires-admin": true, "description": "**Admin only.** MCP tool: `ghost_delete_settings_custom_fields`" } }, "/settings/branding": { "get": { "tags": [ "Settings" ], "summary": "App name, logo and the default language/theme", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Public: the login screen needs it before a session exists.", "x-mcp-exclude": true, "security": [] }, "put": { "tags": [ "Settings" ], "summary": "Update branding and the default language/theme", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsBrandingUpdate" } } } }, "x-requires-admin": true, "x-mcp-exclude": true, "description": "**Admin only.**" } }, "/settings/geocoding": { "get": { "tags": [ "Settings" ], "summary": "Geocoding provider configuration", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "API keys are never returned, only whether each provider has one stored.\n\n**Admin only.**", "x-requires-admin": true, "x-mcp-exclude": true }, "put": { "tags": [ "Settings" ], "summary": "Set the geocoding provider and its API keys", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGeocodingUpdate" } } } }, "x-requires-admin": true, "x-mcp-exclude": true, "description": "**Admin only.**" } }, "/settings/updates": { "get": { "tags": [ "Settings" ], "summary": "Whether the update check is enabled", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-requires-admin": true, "x-mcp-exclude": true, "description": "**Admin only.**" }, "put": { "tags": [ "Settings" ], "summary": "Enable or disable the update check", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "When disabled the server makes no outbound request at all.\n\n**Admin only.**", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsUpdateCheck" } } } }, "x-requires-admin": true, "x-mcp-exclude": true } }, "/settings/tools": { "get": { "tags": [ "Settings" ], "summary": "OSINT tools policy (whether users may add their own tools)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "MCP tool: `ghost_get_settings_tools`" }, "put": { "tags": [ "Settings" ], "summary": "Set the OSINT tools policy", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsTools" } } } }, "x-requires-admin": true, "x-mcp-exclude": true, "description": "**Admin only.**" } }, "/integrations": { "get": { "tags": [ "Integrations" ], "summary": "List installed integrations", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Each entry shows the host it calls, how it authenticates and its operations.\n\nMCP tool: `ghost_get_integrations`" }, "post": { "tags": [ "Integrations" ], "summary": "Install a community integration manifest", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "The manifest is validated; built-in ids can't be replaced. replace=true updates an imported one.\n\n**Admin only.**", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationImport" } } } }, "x-requires-admin": true, "x-mcp-exclude": true } }, "/integrations/draft/test": { "post": { "tags": [ "Integrations" ], "summary": "Integration builder: test one search of an uninstalled integration", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Validates the draft, makes one request through the same guarded client as normal searches, and returns the (trimmed) response. The secret is used once and never stored.\n\n**Admin only.**", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationDraftTest" } } } }, "x-requires-admin": true, "x-mcp-exclude": true } }, "/integrations/draft/map": { "post": { "tags": [ "Integrations" ], "summary": "Integration builder: preview how a response maps to results", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Pure mapping; makes no outbound request.\n\n**Admin only.**", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationDraftMap" } } } }, "x-requires-admin": true, "x-mcp-exclude": true } }, "/integrations/{id}": { "get": { "tags": [ "Integrations" ], "summary": "Get an integration and its full manifest", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "description": "MCP tool: `ghost_get_integrations_by_id`" }, "delete": { "tags": [ "Integrations" ], "summary": "Remove an imported integration", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Refused while tools still use it. Built-ins can't be removed.\n\n**Admin only.**", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "x-requires-admin": true, "x-mcp-exclude": true } }, "/settings/project-retention": { "get": { "tags": [ "Settings" ], "summary": "Archived-project retention period", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-requires-admin": true, "x-mcp-exclude": true, "description": "**Admin only.**" }, "put": { "tags": [ "Settings" ], "summary": "Set the archived-project retention period", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Days a project may stay closed before it and all its data are permanently deleted. 0 means never.\n\n**Admin only.**", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsProjectRetention" } } } }, "x-requires-admin": true, "x-mcp-exclude": true } }, "/settings/model-options": { "get": { "tags": [ "Settings" ], "summary": "List model options (taxonomies: statuses, types, categories)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "MCP tool: `ghost_get_settings_model_options`" }, "post": { "tags": [ "Settings" ], "summary": "Create a model option", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsModelOptionCreate" } } } }, "x-requires-admin": true, "description": "**Admin only.** MCP tool: `ghost_create_settings_model_options`" } }, "/settings/model-options/{id}": { "put": { "tags": [ "Settings" ], "summary": "Update a model option", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsModelOptionUpdate" } } } }, "x-requires-admin": true, "description": "**Admin only.** MCP tool: `ghost_update_settings_model_options`" }, "delete": { "tags": [ "Settings" ], "summary": "Delete a model option", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "x-requires-admin": true, "description": "**Admin only.** MCP tool: `ghost_delete_settings_model_options`" } }, "/users": { "get": { "tags": [ "Users" ], "summary": "List users", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-requires-admin": true, "description": "**Admin only.** MCP tool: `ghost_get_users`" }, "post": { "tags": [ "Users" ], "summary": "Create a user", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "x-requires-admin": true, "description": "**Admin only.** MCP tool: `ghost_create_users`" } }, "/users/directory": { "get": { "tags": [ "Users" ], "summary": "Active users (id, username, email) for member pickers", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Available to any signed-in user, unlike the admin-only user list.\n\nMCP tool: `ghost_get_users_directory`" } }, "/users/{id}": { "get": { "tags": [ "Users" ], "summary": "Get a user", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "x-requires-admin": true, "description": "**Admin only.** MCP tool: `ghost_get_users_by_id`" }, "put": { "tags": [ "Users" ], "summary": "Update a user", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "x-requires-admin": true, "description": "**Admin only.** MCP tool: `ghost_update_users`" }, "delete": { "tags": [ "Users" ], "summary": "Delete a user", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "x-requires-admin": true, "description": "**Admin only.** MCP tool: `ghost_delete_users`" } }, "/audit-logs": { "get": { "tags": [ "Audit Logs" ], "summary": "List audit log entries", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "entity_type", "in": "query", "description": "Filter by entity type", "schema": { "type": "string" } }, { "name": "entity_id", "in": "query", "description": "Filter by entity id", "schema": { "type": "integer" } }, { "name": "user_id", "in": "query", "description": "Filter by the user who made the change", "schema": { "type": "integer" } }, { "name": "action", "in": "query", "description": "Filter by action", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Entries at or after this timestamp", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "Entries at or before this timestamp", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 100 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } } ], "x-requires-admin": true, "description": "**Admin only.** MCP tool: `ghost_get_audit_logs`" } }, "/audit-logs/entity/{entity_type}/{entity_id}": { "get": { "tags": [ "Audit Logs" ], "summary": "Audit history for one entity", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "entity_type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 100 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } } ], "x-requires-admin": true, "description": "**Admin only.** MCP tool: `ghost_get_audit_logs_entity_by_id`" } }, "/audit-logs/stats": { "get": { "tags": [ "Audit Logs" ], "summary": "Audit log statistics", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "start_date", "in": "query", "description": "Count entries at or after this timestamp", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "Count entries at or before this timestamp", "schema": { "type": "string" } } ], "x-requires-admin": true, "description": "**Admin only.** MCP tool: `ghost_get_audit_logs_stats`" } }, "/health": { "get": { "tags": [ "System" ], "summary": "Liveness and database connectivity", "security": [], "x-mcp-exclude": true, "responses": { "200": { "description": "Healthy", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "503": { "description": "Database unreachable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } } }, "/system/health": { "get": { "tags": [ "System" ], "summary": "Process, memory and database diagnostics", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-requires-admin": true, "x-mcp-exclude": true, "description": "**Admin only.**" } }, "/version": { "get": { "tags": [ "System" ], "summary": "Running version and whether a newer release exists", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "force", "in": "query", "description": "Set to 1 to bypass the cached update check", "schema": { "type": "string", "enum": [ "1" ] } } ], "x-mcp-exclude": true } }, "/openapi.json": { "get": { "tags": [ "System" ], "summary": "This document", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mcp-exclude": true } }, "/export": { "get": { "tags": [ "System" ], "summary": "Export investigation data as one JSON file", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Spans all projects. Covers people, businesses, properties, assets, transactions, wireless networks, tools, todos, cases, travel history, custom fields and model options. Not included: crypto wallets, relationship rows, projects and their members, users and audit logs — use a database backup for a complete copy. The file is the input format for POST /import.\n\n**Admin only.**", "x-requires-admin": true, "x-mcp-exclude": true } }, "/import": { "post": { "tags": [ "System" ], "summary": "Import a file produced by GET /export", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Records are created in the project named by project_id, with ids remapped. By default the import is best-effort and reports per-record failures.\n\n**Admin only.**", "parameters": [ { "name": "project_id", "in": "query", "description": "Project the imported records land in", "schema": { "type": "integer" }, "required": true }, { "name": "strict", "in": "query", "description": "Set to 1 to roll the whole import back if any record fails", "schema": { "type": "string", "enum": [ "1" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "string" }, "exportDate": { "type": "string" }, "data": { "type": "object", "additionalProperties": true } }, "required": [ "version", "data" ] } } } }, "x-requires-admin": true, "x-mcp-exclude": true } }, "/upload/logo": { "post": { "tags": [ "System" ], "summary": "Upload an application logo", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "401": { "description": "Not authenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "Returns a logoUrl to store with PUT /settings/branding. Images only, 5 MB limit.\n\n**Admin only.**", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "appLogo": { "type": "string", "format": "binary" } }, "required": [ "appLogo" ] } } } }, "x-requires-admin": true, "x-mcp-exclude": true } } } }