konecty-meta-read
Konecty Meta Read
Read-only access to all Konecty metadata types via the admin API.
Prerequisites
Requires admin credentials from konecty-session: KONECTY_URL and KONECTY_TOKEN in ~/.konecty/.env.
The authenticated user must have admin: true.
API Endpoints
All endpoints require Authorization: <KONECTY_TOKEN> header. All are admin-only.
| Endpoint | Description |
|---|---|
GET /api/admin/meta |
List all document/composite metas (summary) |
GET /api/admin/meta/:document |
List all meta objects for a document (summary) |
GET /api/admin/meta/:document/:type/:name |
Get full meta by type and name |
GET /api/admin/meta/:document/hook/:hookName |
Get hook code (JS) or JSON (validationData) |
Workflow
1. List all documents
python3 scripts/meta_read.py list
python3 scripts/meta_read.py list --format json
2. Inspect all metas for a document
python3 scripts/meta_read.py get Contact
Returns summary of all metas: document, lists, views, access profiles, pivots, cards.
3. Get a specific meta
python3 scripts/meta_read.py get Contact --type list --name Default
python3 scripts/meta_read.py get Contact --type view --name Default
python3 scripts/meta_read.py get Contact --type access --name Corretor
python3 scripts/meta_read.py get Namespace --type namespace --name Namespace
4. Read hook code
python3 scripts/meta_read.py hook Contact scriptBeforeValidation
python3 scripts/meta_read.py hook Product validationData
python3 scripts/meta_read.py hook Contact validationScript
python3 scripts/meta_read.py hook Contact scriptAfterSave
5. List meta types for a document
python3 scripts/meta_read.py types Contact
Shows all meta types and their IDs grouped by type.
Meta types
| Type | _id pattern |
Example |
|---|---|---|
document |
{Name} |
Contact |
composite |
{Name} |
Education |
list |
{Doc}:list:{Name} |
Contact:list:Default |
view |
{Doc}:view:{Name} |
Contact:view:Default |
access |
{Doc}:access:{Name} |
Contact:access:Corretor |
pivot |
{Doc}:pivot:{Name} |
Contact:pivot:Default |
card |
{Doc}:card:{Name} |
Opportunity:card:Default |
namespace |
Namespace |
Namespace |
Detailed schema reference
See references/meta-schemas.md for full schema documentation with annotated examples for each type.
Script reference
See scripts/meta_read.py. Stdlib only (urllib, json).
All subcommands accept:
--host— overridesKONECTY_URL--token— overridesKONECTY_TOKEN
More from konecty/skills
konecty-meta-namespace
Manage Konecty Namespace global configuration: email servers, RabbitMQ queue config, storage, webhooks, plan settings, portal config. Use when the user wants to configure SMTP servers, add RabbitMQ queues, set up storage, configure global webhooks (onCreate/onUpdate/onDelete), manage Konsistent settings, or view global tenant configuration. Requires admin credentials.
9konecty-session
Opens a Konecty session via OTP login (request OTP, then verify OTP) and persists the access token in .env or ~/.konecty/credentials for use by other skills. Use when the user wants to log in to Konecty with OTP, store credentials, set up KONECTY_TOKEN, or establish a session so other Konecty skills can call the API. Only works when the namespace has OTP enabled (email or WhatsApp).
8konecty-create
Creates records in any Konecty module via POST /rest/data/:document. Guides through the full pre-creation workflow: discovering fields and types with konecty-modules, resolving lookup _ids with the built-in lookup command, checking picklist options, validating required fields, and submitting the payload. Use when the user wants to create a new record, insert data, send a message, add an activity, register a contact, create an opportunity, or create any document in Konecty. Requires an active konecty-session (KONECTY_URL and KONECTY_TOKEN in ~/.konecty/.env or ~/.konecty/credentials).
8konecty-meta-list
Manage Konecty list view metadata: show list definitions, manage columns, filters, sorters, calendars, and boards. Use when the user wants to create or modify list views, change column visibility or order, update default filters, or configure calendar/board views. Requires admin credentials.
8konecty-meta-view
Manage Konecty form view metadata: show view definitions, inspect visual tree (visualGroups, visualSymlinks, reverseLookups), upsert views. Use when the user wants to create or modify form layouts, rearrange fields in forms, add visual groups, or configure reverse lookups in views. Requires admin credentials.
8konecty-meta-hook
Generate and manage Konecty hook code: scriptBeforeValidation, validationData, validationScript, scriptAfterSave. Use when the user wants to create, read, update, or delete hooks, generate hook code from requirements, scaffold hook templates, or validate hook correctness. Requires admin credentials.
8