VitrinaAPI

Reference

Every endpoint this API publishes, generated from the same OpenAPI document the backend serves.

These pages are generated from openapi.public.json, the API pública projection the backend derives from its own route definitions. They cannot describe an endpoint that does not exist, and they go stale only if the spec does.

The backend serves more than what is listed here. A resource reaches this reference by being estable or beta (every operation carries a tier — see the versioning page); everything still interna is dropped, because an endpoint we have not committed to is not a contract. You can download the full projection from every page below.

AI agents

The agent that talks on the workspace's behalf: its draft and live config, versions, tools and skills, the voice channel, and the change requests a customer's ask turns into. 75 operations.

Ads

Spend, ROAS and attributed revenue by campaign, creative ranking and attribution health, plus the single tag: the snippet you paste (or its Google Tag Manager installer) and whether it is already sending visits. Reads from Atribu with the workspace's delegated key. 126 operations.

Analytics

The dashboard's reports: conversation volume and resolution, human and AI performance, tool and token usage, and latency. 24 operations.

API keys

Mint, list and revoke the credentials every other call is made with. 4 operations.

Appointments

The hours that are booked and the catalogue of what gets booked: availability, book, move, close and cancel. A test drive and a consultation are the same resource. 22 operations.

Assignment rules

Ordered, first-match-wins routing to a team or an explicit agent pool. 8 operations.

Audiences

Contact segments defined by conditions, with their counts and overlap. 11 operations.

Payment method

The workspace's payment provider and its mandate status — what unlocks self-serve add-on activation — and the write that connects it through Fintoc or Mercado Pago. 18 operations.

Campaigns

Bulk WhatsApp or email sends to an audience: draft, schedule, pause and recipients. 18 operations.

Channels

A messaging channel read + disconnect — connecting one stays a browser flow. 8 operations.

Clinic diagnóstico and commercial numbers

The clinic's free Diagnóstico in one read (status, day of the window and the plan band) and its commercial numbers: presupuesto acceptance, cierres and cash, always aggregated, never a patient. 23 operations.

Clinic agenda

A clinic's day: read the agenda, find free slots, book and move an appointment, with the same ids whichever system runs it. A connected app reads it with patient pseudonyms. 13 operations.

Clinic budgets

Budgets with a folio, their lines with the price frozen, and the treatment plans that order what is to be done. 30 operations.

Clinic till

One shift at one branch: open it with its float, close it against a count and sign off the reconciliation. 7 operations.

Consents

Informed consent against the exact text that was signed, its revocation, and the clinical gallery that consent enables. Marked sensitive. 11 operations.

Record documents

Tests, reports and images hanging off a record, with their retention deadline — and the access and erasure requests of Chile's Ley 21.719. Marked sensitive. 8 operations.

Clinic sterilisation

The sterilisation cycle log: equipment, lote, date and time, who ran it, result with its indicator and the packs in the cycle, with CSV and PDF export by period and equipment; the lote used is noted on the atención. 8 operations.

Clinic HR

The read-only Buk connection and the month's payroll cost, summed from the closed settlements without storing the per-person detail. 12 operations.

Clinic laboratory

The clinic's laboratories, their price list by type of work and the orders sent to them, with each order's status. 9 operations.

Clinic lines of care

The clinic's short list of what patients come for (Implants, Aesthetics, Endodontics…): every roster specialty and every ad belongs to one line, and every lead carries one. 9 operations.

Session packs

Sessions sold up front: the catalogue's pack, one patient's purchase and its derived balance. 13 operations.

Patient register

Who is a patient of the clinic and who answers for them: the identity record, the duplicates and the family bonds. Marked sensitive — it asks for its own scope and no connected app reaches it. 20 operations.

Clinic pricing

Price lists, rules and agreements, and the quote that explains what one service costs one patient. 19 operations.

Clinic professionals

Who sees patients at the clinic, in which speciality and with what default block — the id the agenda uses as a lane. 9 operations.

Clinical record

What was done to a person and why: encounters, signed notes, antecedentes, alerts, intake forms and the chart with its history. Marked sensitive. 51 operations.

Insurance reimbursements

The reimbursement request to the insurer per atención, with its documents and states (to send, sent, paid, rejected), the insurer's payments and their reconciliation with the requests they settle, partial included. Insurer money is never counted twice: it is not a Caja payment or an espejo de ingresos row. 13 operations.

Clinic insurance

The patient's insurance (several, one primary), the coverage table per plan and prestación, and the estimated coverage and copago on the presupuesto and the estado de cuenta, in PDF too. Coverage is never a discount: prices and convenios do not change. 13 operations.

Clinic services

What the clinic performs: duration, list price, consent requirements and who may perform each service. 19 operations.

Templates and retention

The texts and the questions before anybody signs or answers them, and how many years each kind of document is kept. They name no patient, and are therefore not sensitive. 18 operations.

Clinic bank feed

The clinic's bank movements, from e-mail, Fintoc or the bank's own API, normalized into one shape to reconcile the till. 6 operations.

Clinic commissions

Each professional's commission history: the months Vitrina settles next to the liquidaciones Dentalink issued, imported read-only, and the Dentalink exports the clinic uploads. 4 operations.

Home panel suggestions

Up to three cards carrying the clinic's own number that justifies opening a module (payments without a receipt, unsettled commissions, unreconciled payments, accepted budgets without an appointment, advertising spend), and how to dismiss one for the member viewing it. 2 operations.

Clinic supplies inventory

The clinic's supplies with their stock, minimum and last price; every entry, exit and count is recorded with who, when and why, and the ones below their minimum show as «Por reponer». 29 operations.

Companies

The organisations contacts belong to. They group people; the legal identity lives on the contact that represents the company. 5 operations.

Consignments

The contract under which a dealer sells someone else's car: create, edit, return and sell with its settlement. 8 operations.

Contacts

The people a workspace talks to: search, create, correct, merge, tag, and the channels and attributes hanging off each one. 39 operations.

Conversations

The threads with customers and patients: read the inbox, reply, assign, snooze and resolve — with the author of every message. 61 operations.

The workspace's email voice

What an assistant should read before writing an email on the workspace's behalf: language, style guide, the AI agent's persona and the team's recent real emails. 1 operation.

Credit applications

The dossier that chases a bank carpeta: record, mark sent, record the lender’s answer, and withdraw. 8 operations.

Custom attributes

Each workspace's own fields: the definition once, then the value on each contact or conversation. 7 operations.

Custom tools

The Tool Store: teach the agent to call the workspace's own API with no code — a request template plus a parameter list. 8 operations.

Monday summary

The Monday summary settings: send day and hour, channels (email, and WhatsApp which is opted into separately), recipients and the state of the WhatsApp templates. 2 operations.

Document payments

Record money against a reservation or a sale note. A legacy door — POST /payments is the newer, fuller path. 2 operations.

Document templates

The standard text of each document family (sale note, reservation, quote, consignment, purchase note, spec sheet), with the variables it uses. 3 operations.

Email drafts

An email someone, or their AI assistant, leaves ready for a person to review and send: list, create, edit, discard and send. 6 operations.

Email templates

The reusable email bodies campaigns send. 6 operations.

Add-ons

The add-on catalog, the ones this workspace has ever held and the live usage of the metered ones — and the two self-serve writes to activate or cancel one. 3 operations.

Finanzas

The business's back-office money, for any vertical: connected banks, Mercado Pago and SII, with their status and last sync. 158 operations.

Follow-ups

Follow-up recipes, each customer's Búsquedas, demand, Recontacto and its review queue. 53 operations.

Help centers

The customer-facing documentation portal: sections, multi-locale articles and their sync into the knowledge base. 40 operations.

VAT regime

Whether a car sells with VAT (afecto) or without it (exento): the dealership's default and the per-unit decision, captured at intake and never rewritten by a later default change. 4 operations.

Inbox views

Saved inbox filters, team-wide or personal, by conversation attributes; a team view can take its conversations out of «Esperando respuesta». 7 operations.

Dealership insights

The Comisiones export for the month-end close, as Excel or CSV: one row per seller and deal with the commission arithmetic visible, and a summary of what each person is owed. 2 operations.

Instagram posts

Prepare a vehicle's Instagram post (a caption written in the dealership's own style, plus the first photos) and approve it to publish or schedule it. Nothing posts without the approval. 2 operations.

Integrations · Meta Ads

The Meta Ads account connection: start it, resolve the account selection when there is more than one, disconnect it, and read the workspace's click-to-WhatsApp ads. 26 operations.

Knowledge base — sources and indexed text

The agent's hand-authored sources — a problem, its root cause and the solution steps, written by hand instead of uploaded — and a library file's indexed text: literally what the agent searches. 10 operations.

Knowledge base — files

The workspace's uploaded document library: one is uploaded or authored from a URL, then attached to one or more agents. 10 operations.

Leads

The opportunities a workspace is working: open them, move them across the board, close them won, lost or unqualified, and read the funnel. 34 operations.

Locations

The workspace's branches, and the address they are shown with. 5 operations.

Macros

Saved replies with automated side-effects an agent applies in one click. 8 operations.

Margin and profitability

The Resumen del negocio of one sold unit (as JSON, PDF, Excel or CSV) and the Margen y rentabilidad export: one row per sale note in the period, with the business figures net of IVA and the buyer figures gross of it. 5 operations.

Marketplaces

Connected portal accounts: their health, their sync history and «Sync now». 6 operations.

My notifications

What the caller sees: the notification feed for the active workspace and their notification preferences, by preset or cell by cell. 3 operations.

Media library

Photos, videos, PDFs and audio the team and the agent send, with a «when to use it» note, topics and consent for patient photos. 8 operations.

Improvements

What the nightly reviewer found in your agent: dismiss or resolve a finding, and rate a handoff. 2 operations.

Team

The workspace's members and their invitations: add one, change a role or branch, and remove one — removal always hands off the person's open work instead of stranding it. 10 operations.

Sending mailboxes

The mailboxes the signed-in teammate may send a new email from: their own and the workspace principal, with which one is the default. Its id is the from_account_id of a send or a draft. 12 operations.

Orders

Every sale as an order: lines priced from the catalog, a Mercado Pago payment link, shipping and delivery. 19 operations.

Legal identity

The dealership's legal identity (legal name, RUT, line of business, address, representative and deed) and its powers of attorney. Without it, printing a sale note or a compraventa answers 409. 6 operations.

Outbound approvals

Messages waiting for a person to approve them before they go out, from any rail. 11 operations.

Clinic payment registrations

The Mercado Pago payments still to be recorded in the clinic's practice system: the task list, confirming which practice-system payment matches each one or closing it without a match, and which payment method stands for Mercado Pago. 6 operations.

Payment settings

How the business charges per charge type, from which amount a payment link offers installments, what «aceptar y pagar» charges on a budget, and the Mercado Pago connection. 24 operations.

Charges and payments

The workspace ledger: what is owed, what arrived and how the second is allocated to the first. 31 operations.

Personal tokens

The credential a member mints for themselves: it sees exactly what that person sees, and stops working when that person loses access. 3 operations.

Pipelines

The boards work moves across, and the versioned templates one is built from. 12 operations.

Price approvals

Authority over a below-reference price: the asker and the decider must be different people. 5 operations.

Products

The catalog of what you sell when it is not vehicles, and its publication to your channels. 12 operations.

Projects

A real-estate developer's projects, their unit models, their stock of units (apartments, houses, parking spaces and storage units) and their versioned price list in UF and PDF quotes with down payment and mortgage payment, with an Excel import. 163 operations.

Properties

A real-estate broker's portfolio: each property with its operation, price in UF or CLP, features and status. 14 operations.

Public stock

A dealership's published lot: list, count and read one unit. This is the surface a dealer website consumes. 7 operations.

Purchase notes

The instrument that creates a vehicle's cost basis: issue, correct and void. 6 operations.

Quotes

A price offer on a unit, frozen at issuance. It reserves nothing: several customers may hold a live quote on the same car. 6 operations.

Reservations

The only one of these eight that locks inventory: takes a hold on a unit, with an optional deposit and a term. 10 operations.

Custom roles

The per-role scope and visibility catalog — effective access, not a label. 5 operations.

SLAs

The first-response and resolution targets a ticket must meet, and which channels/priorities trigger them. 5 operations.

Sale notes

The document that sells the car: issue, approve (the instant it becomes legally valid and the unit is marked sold) and void. 11 operations.

Sandbox

A synthetic workspace apart from your real data, with sk_test_ keys: provision it, reset it and see what was captured instead of sent. 6 operations.

Sending domains

A workspace's own domain for sending email campaigns, with its DKIM records and verification. 5 operations.

Sequences

Every follow-up path (On arrival, If they go quiet, Notices) with its steps, waits, channels and results. 28 operations.

Stages

A board's columns: their category, their ageing threshold and which other columns a card may jump to. 7 operations.

Store setup

What a new store still needs before it sells through the chat: connect the store, review the catalog, connect Mercado Pago. 2 operations.

Tags

The loose vocabulary hung off a conversation or a contact: attaching by name creates it on first use. 6 operations.

Teams

The routing destination channels and tickets hang off, and its own coverage-hours schedule. 9 operations.

Workspace settings

The workspace's general identity (name, time zone, language, currency, website) and its Vitrina Ads choices: how the tag step was answered and the monthly goal. 4 operations.

Tickets

The case that outlives the thread: it can own several conversations, lives on a column of a board, and has an owner and an SLA. 21 operations.

Tool credentials

The vault behind an authenticated custom tool — the secret is never shown again, only a preview. 5 operations.

Triggers

Event → condition → action automations: assign, tag, move stage or notify without a person doing it by hand. 5 operations.

Vehicle attachments

Documents and files hanging off one unit. 5 operations.

Vehicles

Stock from the inside: create, edit, stages, portal publications and the inventory maintenance tools. Needs wider scopes than public stock. 54 operations.

Voice clips

Recorded voice notes the team and the agent reuse, with transcript, expiry and a model filter. 6 operations.

Webhooks

Subscriptions to the workspace's events, and the log of every delivery. 9 operations.

WhatsApp Flows

Structured, multi-screen forms a WhatsApp conversation can open, built and published from Vitrina. 17 operations.

WhatsApp templates

The catalog of Meta-approved message shapes for writing outside the 24-hour window, and how Vitrina fills each variable. 22 operations.

Generated from an OpenAPI document with 2135 paths and 2697 operations; 1791 of them are published here.