Scheduling, availability, clients, billing and CRM for appointment-based services.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Organization API key (sk_admin_...). Required for org-scoped tools. Omit it to use the public booking lane.
Bootstrap key for admin_create_organization only. Self-service at https://coordinalo.com/developers
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Add a bookable service to an organization. Use after admin_create_organization. Auto-discoverable by default. If the org has exactly one active provider, the service is auto-assigned to them. With multiple providers, use service_assign_provider to assign manually — unassigned services block admin_toggle_discoverable. Next step: admin_set_availability to configure the provider schedule. Requires X-Org-Api-Key header.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Add a bookable service to an organization. Use after admin_create_organization. Auto-discoverable by default. If the org has exactly one active provider, the service is auto-assigned to them. With multiple providers, use service_assign_provider to assign manually — unassigned services block admin_toggle_discoverable. Next step: admin_set_availability to configure the provider schedule. Requires X-Org-Api-Key header.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| price* | number | |
| apiKey | string | |
| orgSlug* | string | |
| currency | string | |
| vertical | string | |
| description | string | |
| duration_minutes* | integer |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"name",
"duration_minutes",
"price"
],
"properties": {
"name": {
"type": "string"
},
"price": {
"type": "number",
"minimum": 0
},
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"currency": {
"enum": [
"CLP",
"UF",
"USD"
],
"type": "string"
},
"vertical": {
"type": "string"
},
"description": {
"type": "string"
},
"duration_minutes": {
"type": "integer",
"maximum": 480,
"minimum": 5
}
}
}List active providers (professionals) for an organization. Use this to get providerId before calling admin_set_availability. The org owner is auto-provisioned as a provider. Requires X-Org-Api-Key header.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}Replace the weekly availability schedule for a provider (not additive — overwrites all existing blocks). Get providerId from admin_list_providers first. Schedule uses day names and HH:MM times. Requires X-Org-Api-Key header.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| schedule* | array | |
| providerId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"providerId",
"schedule"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"schedule": {
"type": "array",
"items": {
"type": "object",
"required": [
"day",
"start",
"end"
],
"properties": {
"day": {
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"type": "string"
},
"end": {
"type": "string"
},
"start": {
"type": "string"
}
}
}
},
"providerId": {
"type": "string"
}
}
}Toggle the LIFECYCLE flags isPublic and servicialoPublished. ⚠️ This tool does NOT grant public discovery consent — discovery in the Servicialo registry requires Organization.discoveryConsent=true, which can ONLY be set by the human owner via PATCH /api/organizations/:slug/servicialo from the web panel (a deliberate, authenticated consent action). Without consent, the cron registry-sync and resolver-heartbeat skip the org, so calling this tool with discoverable=true on a non-consented org flips local flags but does not publish anywhere. Requires X-Org-Api-Key header.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| discoverable* | boolean |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"discoverable"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"discoverable": {
"type": "boolean"
}
}
}Create a public agenda — a shareable booking page where external clients can self-book appointments. Links to a specific provider and/or service. The agenda gets a public URL at /{orgSlug}/agenda/{slug}. Create this after services and availability are configured. Without a public agenda, clients can only be booked via the API or dashboard.
| Argument | Type | Description |
|---|---|---|
| slug* | string | |
| title | string | |
| apiKey | string | |
| orgSlug* | string | |
| isActive | boolean | |
| isPublic | boolean | |
| description | string | |
| proveedorId | string | |
| showSessions | boolean | |
| showClientNames | boolean | |
| bookingFlowOrder |
Delete a public agenda permanently. Cascades to related sessions booked through this agenda, comments, and service configs. Requires confirm: true. Cannot be undone.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| agendaId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"agendaId",
"confirm"
],
"properties": {
"apiKey": {
"type": "string"
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"agendaId": {
"type": "string"
}
}
}Get complete details of a public agenda by ID. Returns all configuration including booking flow (service_first, provider_first, auto), selection modes, assignment strategy, privacy settings, linked provider/service, and session count. Use before agendas_update to inspect current settings.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| agendaId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"agendaId"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"agendaId": {
"type": "string"
}
}
}List public agendas for an organization. Returns agendas with their provider, service, and session counts.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}Update a public agenda’s configuration. Partial update — only provided fields are changed. Supports modifying: title, description, visibility (isPublic/isActive), booking flow order (service_first/provider_first/auto), selection modes for service and provider (required/optional/auto/hidden), assignment strategy (manual/round_robin/least_booked/most_available/priority/random), privacy flags (showSessions, showClientNames, showProviderUtilization, showProviderList), prepayment, and provider/service linking. When a provider is assigned, their services are auto-linked to the agenda.
| Argument | Type | Description |
|---|---|---|
| slug | string | |
| title | string | |
| apiKey | string | |
| orgSlug* | string | |
| agendaId* | string | |
| category | string | |
| isActive | boolean | |
| isPublic | boolean | |
| expiresAt | string | |
Get the configured weekly availability schedule for a provider (not free slots, but the base configuration). Use admin_set_availability to modify.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| providerId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"providerId"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"providerId": {
"type": "string"
}
}
}Query available time slots within a date range. Agenda-aware: without clientId, filters by the org default public agenda — each org decides which services to expose. With clientId, resolves the client titular provider and returns their full service catalog. Five modes: (1) orgSlug only — slots from the public agenda grouped by service, provider auto-assigned at booking; (2) orgSlug + clientId — resolves titular provider if set, falls back to agenda; (3) orgSlug + agendaId — slots for a specific agenda; (4) serviceId — slots for all providers assigned to that service; (5) providerId — slots for a specific provider. Modes 1–3 hide provider details. Use before booking_create.
| Argument | Type | Description |
|---|---|---|
| date | string | |
| apiKey | string | |
| dateTo | string | |
| orgSlug* | string | |
| agendaId | string | |
| clientId | string | |
| dateFrom | string | |
| duration | integer | |
| timezone | string |
Cancel an existing session. By default applies the org cancellation policy: the charge is computed from the no-charge/partial/full windows and, if the policy has autoApply, registered as a penalty transaction (money-write). Set applyCancellationPolicy: false to waive the charge. Requires confirm: true.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| reason* | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| sessionId* | string | |
| cancelledBy | string | |
| applyCancellationPolicy | boolean |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"sessionId",
"reason",
"confirm"
],
"properties": {
"apiKey": {
"type": "string"
},
"reason": {
"type": "string",
"maxLength": 500
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"sessionId": {
"type": "string"
},
"cancelledBy": {
"enum": [
"client",
"provider",
"admin"
],
"type": "string"
},
"applyCancellationPolicy": {
"type": "boolean"
}
}
}Create a new session/appointment for a client. providerId is optional — if omitted, the system auto-assigns a provider using the agenda assignment strategy (round_robin, least_booked, etc.). When a client has a titular provider, that provider is preferred automatically. Without providerId and without publicAgendaId, the org default public agenda is used. Preconditions: (1) service must exist and be active, (2) client must exist (use client_create first). Use availability_get_slots to find valid time slots before calling this. Set retroactive: true to register past sessions (skips slot validation, sets status to completed by default). Use autoCharge: true with retroactive to auto-generate the charge. Retroactive sessions are tagged with self_declared provenance. Max 365 days in the past. Past dates are auto-detected as retroactive — the retroactive flag is optional (system infers it from scheduledAt).
| Argument | Type | Description |
|---|---|---|
| notes | string | |
| apiKey | string | |
| orgSlug* | string | |
| clientId* | string | |
| duration | integer | |
| modalidad | string | |
| serviceId* | string | |
Create recurring sessions (e.g. weekly therapy). Generates multiple individual sessions linked by a recurrence series ID. Max 52 occurrences.
| Argument | Type | Description |
|---|---|---|
| notes | string | |
| apiKey | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| clientId* | string | |
| timezone* | string | |
| serviceId | string | |
| providerId* | string | |
| recurrence* | object | |
| skipConflicts | boolean |
Get complete details of a session/appointment by its ID, including client, provider, service, financial, and delivery proof information.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| sessionId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"sessionId"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"sessionId": {
"type": "string"
}
}
}List sessions for an organization with filters by provider, client, service, status, and date range. Supports cursor-based pagination.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| apiKey | string | |
| cursor | string | |
| dateTo | string | |
| status | any | |
| orderBy | string | |
| orgSlug* | string | |
| clientId | string | |
| dateFrom | string | |
| serviceId | string | |
| providerId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"cursor": {
"type": "string"
},
"dateTo": {
"type": "string"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"orderBy": {
"enum": [
"scheduledAt_asc",
"scheduledAt_desc"
],
"type": "string"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
},
"dateFrom": {
"type": "string"
},
"serviceId": {
"type": "string"
},
"providerId": {
"type": "string"
}
}
}List the reschedule requests (SessionRequest) of an organization — the org side of the bilateral coordination loop a client opens from the portal. Filter by status (pending|all|resolved, default pending), sessionId or clientId. Returns the proposed slot, current session state, and who proposed it. Cursor-paginated. Set includePendingCount: true to also get the count of pending requests (powers the sidebar badge). Read-only. Use booking_resolve_request to approve or reject one.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| apiKey | string | |
| cursor | string | |
| status | string | |
| orgSlug* | string | |
| clientId | string | |
| sessionId | string | |
| includePendingCount | boolean |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"cursor": {
"type": "string"
},
"status": {
"enum": [
"pending",
"all",
"resolved"
],
"type": "string"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
},
"sessionId": {
"type": "string"
},
"includePendingCount": {
"type": "boolean"
}
}
}Reschedule a session to a new time. Cancels the original and creates a new one. Requires confirm: true.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| reason | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| sessionId* | string | |
| newProviderId | string | |
| newScheduledAt* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"sessionId",
"newScheduledAt",
"confirm"
],
"properties": {
"apiKey": {
"type": "string"
},
"reason": {
"type": "string",
"maxLength": 500
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"sessionId": {
"type": "string"
},
"newProviderId": {
"type": "string"
},
"newScheduledAt": {
"type": "string"
}
}
}Approve or reject a pending reschedule request (SessionRequest) that a client proposed from the portal — closes the bilateral coordination loop. outcome: "approved" applies the reschedule atomically (moves the session to the proposed slot in the same transaction); "rejected" requires a reason of at least 10 characters. Idempotent: a request already resolved returns a conflict with its current status. Emits the corresponding session lifecycle events.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| reason | string | |
| orgSlug* | string | |
| outcome* | string | |
| requestId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"requestId",
"outcome"
],
"properties": {
"apiKey": {
"type": "string"
},
"reason": {
"type": "string",
"maxLength": 500
},
"orgSlug": {
"type": "string"
},
"outcome": {
"enum": [
"approved",
"rejected"
],
"type": "string"
},
"requestId": {
"type": "string"
}
}
}Advance a session through the Servicialo lifecycle: confirm, start, complete, or mark as no-show. NOTE: the "deliver" action is NOT available via MCP (ref PDC-SEC-001) — MCP authentication cannot validate actor-as-Proveedor. Delivery must be performed via the REST endpoint PATCH /api/organizations/[orgSlug]/coordinalo/sessions/[sessionId]/deliver which enforces provider binding.
| Argument | Type | Description |
|---|---|---|
| notes | string | |
| action* | string | |
| apiKey | string | |
| orgSlug* | string | |
| sessionId* | string | |
| noShowType | string | |
| deliveryType | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"sessionId",
"action"
],
"properties": {
"notes": {
"type": "string",
"maxLength": 1000
},
"action": {
"enum": [
"confirm",
"start",
"complete",
"deliver",
"no_show"
],
"type": "string"
},
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"sessionId": {
"type": "string"
},
"noShowType": {
"enum": [
"client",
"provider"
],
"type": "string"
},
"deliveryType": {
"enum": [
"completo",
"parcial"
],
"type": "string"
}
}
}Close the organizational period. Requires ALL active clients with historialCompleto=true to be closed first. Freezes the period. Requires confirm: true.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| periodo* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"periodo",
"confirm"
],
"properties": {
"apiKey": {
"type": "string"
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"periodo": {
"type": "string"
}
}
}Create a client monthly closing (immutable financial snapshot). Requires historialCompleto=true on the client. One closing per client per period. Requires confirm: true.
| Argument | Type | Description |
|---|---|---|
| notas | string | |
| apiKey | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| periodo* | string | |
| clientId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"clientId",
"periodo",
"confirm"
],
"properties": {
"notas": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"periodo": {
"type": "string"
},
"clientId": {
"type": "string"
}
}
}Distribute profits for a closed period. Freezes the current period and all prior open periods. Requires the period to be organizationally closed first. Requires confirm: true.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| periodo* | string | |
| montoDistribuido* | number |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"periodo",
"montoDistribuido",
"confirm"
],
"properties": {
"apiKey": {
"type": "string"
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"periodo": {
"type": "string"
},
"montoDistribuido": {
"type": "number",
"minimum": 0
}
}
}Delete (reopen) a client closing. Only allowed if the organizational period is not frozen. Requires confirm: true.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| cierreId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"cierreId",
"confirm"
],
"properties": {
"apiKey": {
"type": "string"
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"cierreId": {
"type": "string"
}
}
}Evaluate organizational closing readiness for a period. Returns: active clients, closed count, excluded count, pending count, completion percentage, and whether closing is possible.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| periodo* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"periodo"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"periodo": {
"type": "string"
}
}
}List client closings for an organization. Filter by period and/or client.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| periodo | string | |
| clientId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"periodo": {
"type": "string"
},
"clientId": {
"type": "string"
}
}
}List retained earnings (utilidades retenidas) for an organization. Returns per-period records with accumulated totals: ingresos, costos, utilidadNeta, distribuido, retenido.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}Preview the financial snapshot for a client in a period WITHOUT creating the closing. Returns totals for ventas, cobros, pagos, sessions.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| periodo* | string | |
| clientId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"clientId",
"periodo"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"periodo": {
"type": "string"
},
"clientId": {
"type": "string"
}
}
}Create a new client in the organization. If a Person with the same email exists, it will be linked (not duplicated).
| Argument | Type | Description |
|---|---|---|
| rut | string | |
| name* | string | |
| string | ||
| notes | string | |
| phone | string | |
| apiKey | string | |
| comuna | string | |
| orgSlug* | string | |
| lastName* | string | |
| direccion | string | |
| idempotencyKey | string | |
| proveedorTitularId |
Get complete details of a client including financial summary and recent sessions.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| clientId* | string | |
| includeHistory | boolean | |
| includeFinancials | boolean |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"clientId"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
},
"includeHistory": {
"type": "boolean"
},
"includeFinancials": {
"type": "boolean"
}
}
}List clients of an organization with search and pagination. Can filter by provider or outstanding debt.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| apiKey | string | |
| cursor | string | |
| search | string | |
| hasDebt | boolean | |
| orgSlug* | string | |
| providerId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"cursor": {
"type": "string"
},
"search": {
"type": "string"
},
"hasDebt": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"providerId": {
"type": "string"
}
}
}Update an existing client's personal data. Email cannot be changed via MCP.
| Argument | Type | Description |
|---|---|---|
| rut | string | |
| name | string | |
| notes | string | |
| phone | string | |
| apiKey | string | |
| comuna | string | |
| orgSlug* | string | |
| clientId* | string | |
| lastName | string | |
| direccion | string | |
| proveedorTitularId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"clientId"
],
"properties": {
"rut": {
"type": "string"
},
"name": {
"type": "string"
},
"notes": {
"type": "string"
},
"phone": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"comuna": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
},
"lastName": {
"type": "string"
},
"direccion": {
"type": "string"
},
"proveedorTitularId": {
"type": "string"
}
}
}Create a new email campaign with HTML body to send to a segmented audience. Supports variable substitution: {nombre}, {apellido}, {nombre_completo}, {email}, {telefono}, {organizacion}. Use audienceType "predefined" with audienceId "active"/"inactive"/"new"/"withPhone"/"withoutPhone", or "adhoc" with custom filters. On send, links in the body are auto-tagged with UTMs (utm_campaign = stable slug from campaign name) and a legal footer with unsubscribe link is appended. Returns campaign ID and recipient count. Campaign starts as draft — use comms_send_campaign to execute. Requires confirm: true.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| type | string | |
| apiKey | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| emailBody* | string | |
| audienceId | string | |
| adHocFilters | object | |
| audienceType* |
Get details of a specific campaign with optional delivery logs per recipient.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| logLimit | integer | |
| campaignId* | string | |
| includeLogs | boolean |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"campaignId"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"logLimit": {
"type": "integer",
"maximum": 200,
"minimum": 1
},
"campaignId": {
"type": "string"
},
"includeLogs": {
"type": "boolean"
}
}
}Get the communication preferences for an organization (WhatsApp, email, confirmation, reminder channels and messages).
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}List the saved audiences/segments used for campaign targeting, each with its filter definition and campaign-usage count. Set includeCount: true to also resolve how many clients currently match each audience, and includePredefined: true to include built-in predefined segments. Read-only — use before comms_create_campaign to pick a target audience.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| includeCount | boolean | |
| includePredefined | boolean |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"includeCount": {
"type": "boolean"
},
"includePredefined": {
"type": "boolean"
}
}
}List communication campaigns (WhatsApp/email) for the organization. Filter by status.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| apiKey | string | |
| cursor | string | |
| status | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"cursor": {
"type": "string"
},
"status": {
"enum": [
"draft",
"scheduled",
"sent",
"completed",
"failed"
],
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}Render a communication template as a visual image (PNG). Available templates: session-confirmation, session-reminder, payment-reminder. Use action "preview" to get the image URL, "send" to render and send via WhatsApp with the image attached. Each template requires specific data fields (clientName, providerName, date, time, etc.).
| Argument | Type | Description |
|---|---|---|
| data* | object | |
| width | number | |
| action | string | |
| apiKey | string | |
| orgSlug* | string | |
| clientId | string | |
| template* | string | |
| whatsappTo | string | |
| whatsappBody | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"template",
"data"
],
"properties": {
"data": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"width": {
"type": "number"
},
"action": {
"enum": [
"preview",
"upload",
"send"
],
"type": "string",
"default": "preview"
},
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
},
"template": {
"enum": [
"session-confirmation",
"session-reminder",
"payment-reminder"
],
"type": "string"
},
"whatsappTo": {
"type": "string"
},
"whatsappBody": {
"type": "string"
}
}
}Execute a draft or scheduled campaign. Sends messages to all matching recipients asynchronously, skipping recipients with email opt-out or bounced addresses (logged as "skipped"). Campaign must be in draft or scheduled status. Returns immediately — use comms_get_campaign to track progress (sent/delivered/opened/clicked update via provider webhooks). Requires confirm: true.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| campaignId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"campaignId",
"confirm"
],
"properties": {
"apiKey": {
"type": "string"
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"campaignId": {
"type": "string"
}
}
}Send a single WhatsApp or email message to a specific client. Use templateKey for predefined templates or customMessage for free text. Requires confirm: true.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| channel* | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| clientId* | string | |
| variables | object | |
| templateKey | string | |
| customMessage | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"clientId",
"channel",
"confirm"
],
"properties": {
"apiKey": {
"type": "string"
},
"channel": {
"enum": [
"whatsapp",
"email"
],
"type": "string"
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
},
"variables": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"templateKey": {
"type": "string"
},
"customMessage": {
"type": "string",
"maxLength": 2000
}
}
}Enable or disable communication channels and features for an organization. Partial update — only provided fields are changed. Creates preferences if none exist.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| emailEnabled | boolean | |
| phoneRequired | boolean | |
| whatsappEnabled | boolean | |
| emailReminderEnabled | boolean | |
| phoneRequiredMessage | string | |
| whatsappReminderEnabled | boolean | |
| whatsappReminderMessage | string | |
| emailConfirmationEnabled | boolean | |
| whatsappConfirmationEnabled |
List the delivery-confirmation ledger for an organization's sessions. Each row reflects the DeliveryProof overlay: whether the provider confirmed delivery, whether the client confirmed, and whether the system auto-confirmed after the verification window (silence). Filter by state — awaiting_client (provider confirmed, client has not, not yet auto-confirmed), confirmed (client confirmed or auto-confirmed), or provider_pending (proof exists but the provider has not confirmed delivery) — or look one up by sessionId. Privacy: returns confirmation flags/timestamps and a hasEvidence boolean only, never the evidence summary content.
| Argument | Type | Description |
|---|---|---|
| page | integer | |
| limit | integer | |
| state | string | |
| apiKey | string | |
| orgSlug* | string | |
| sessionId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"state": {
"enum": [
"awaiting_client",
"confirmed",
"provider_pending"
],
"type": "string"
},
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"sessionId": {
"type": "string"
}
}
}List disputes for an organization. Filter by status or type. Returns disputes with client and provider info.
| Argument | Type | Description |
|---|---|---|
| page | integer | |
| type | string | |
| limit | integer | |
| apiKey | string | |
| status | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
"type": {
"type": "string"
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"status": {
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}Update dunning (payment recovery) configuration for an organization. All fields except organizationSlug are optional — only provided fields are updated, rest stays unchanged.
| Argument | Type | Description |
|---|---|---|
| steps | array | |
| enabled | boolean | |
| blockOnStep5 | boolean | |
| gracePeriodDays | integer | |
| organizationSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"organizationSlug"
],
"properties": {
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"step",
"daysAfterDue"
],
"properties": {
"step": {
"type": "integer",
"maximum": 5,
"minimum": 1
},
"channel": {
"enum": [
"whatsapp",
"email",
"both"
],
"type": "string"
},
"daysAfterDue": {
"type": "integer",
"maximum": 90,
"minimum": 0
}
}
},
"maxItems": 5
},
"enabled": {
"type": "boolean"
},
"blockOnStep5": {
"type": "boolean"
},
"gracePeriodDays": {
"type": "integer",
"maximum": 30,
"minimum": 0
},
"organizationSlug": {
"type": "string"
}
}
}Get the current dunning (payment recovery) configuration for an organization. Returns whether dunning is enabled, grace period, step timings, and blocking settings.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| organizationSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"organizationSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"organizationSlug": {
"type": "string"
}
}
}Remove the configured email sending domain from the organization. This deletes it from both Resend and the database. The organization will revert to using the default Coordinalo sending address. Requires confirm: true.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| confirm* | boolean | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"confirm"
],
"properties": {
"apiKey": {
"type": "string"
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
}
}
}Get the email sending domain configured for an organization and its verification status (PENDING, VERIFIED, FAILED). Returns null if no domain is configured. Use email_domain_register to set one up.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}Register a custom email sending domain for an organization via Resend. Returns DNS records that must be configured in the domain provider before verification. Replaces any previously configured domain. After adding DNS records, call email_domain_verify to check status.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| domain* | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"domain"
],
"properties": {
"apiKey": {
"type": "string"
},
"domain": {
"type": "string",
"minLength": 3
},
"orgSlug": {
"type": "string"
}
}
}Trigger DNS verification for the configured email domain and return updated status. Call this after the organization has added the required DNS records. Status will be VERIFIED (ready to send), PENDING (DNS not yet propagated), or FAILED.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}Get accounts receivable aging report: pending charges grouped by age buckets (0-7, 7-30, 30-90, 90+ days). Use to answer "who owes money" or "old debts" questions.
| Argument | Type | Description |
|---|---|---|
| limit | number | |
| apiKey | string | |
| cursor | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"limit": {
"type": "number",
"maximum": 200,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"cursor": {
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}Get the complete financial balance for a client: total sales, charges, payments, pending debt, and credits.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| clientId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"clientId"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
}
}
}Create a manual charge (cobro) for a client. Not linked to a sale/venta. Requires confirm: true.
| Argument | Type | Description |
|---|---|---|
| tipo | string | |
| fecha | string | |
| monto* | number | |
| apiKey | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| clientId* | string | |
| descripcion* | string | |
| idempotencyKey | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"clientId",
"monto",
"descripcion",
"confirm"
],
"properties": {
"tipo": {
"type": "string"
},
"fecha": {
"type": "string"
},
"monto": {
"type": "number",
"exclusiveMinimum": 0
},
"apiKey": {
"type": "string"
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
},
"descripcion": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
}
}
}Create a service sale (venta) for a client. Optionally auto-creates a charge (cobro) depending on org configuration. Requires confirm: true.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| estado | string | |
| precio* | number | |
| confirm* | boolean | |
| orgSlug* | string | |
| cantidad | integer | |
| clientId* | string | |
| fechaRef | string | |
| servicioId* | string | |
| proveedorId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"clientId",
"servicioId",
"precio",
"confirm"
],
"properties": {
"apiKey": {
"type": "string"
},
"estado": {
"enum": [
"realizado",
"proyectado"
],
"type": "string"
},
"precio": {
"type": "number",
"minimum": 0
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"cantidad": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
"clientId": {
"type": "string"
},
"fechaRef": {
"type": "string"
},
"servicioId": {
"type": "string"
},
"proveedorId": {
"type": "string"
}
}
}Get details of a specific charge (cobro) including all associated payments.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| cobroId* | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"cobroId"
],
"properties": {
"apiKey": {
"type": "string"
},
"cobroId": {
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}List charges (cobros) for an organization. Filter by client, status, or date range. Includes summary totals.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| apiKey | string | |
| cursor | string | |
| dateTo | string | |
| estado | any | |
| orgSlug* | string | |
| clientId | string | |
| dateFrom | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"cursor": {
"type": "string"
},
"dateTo": {
"type": "string"
},
"estado": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
},
"dateFrom": {
"type": "string"
}
}
}List pending charge confirmations and their status. Shows cobros in pending_confirmation state that await client verification. Filter by client or confirmation status (pending, confirmed, disputed, auto_confirmed).
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| status | string | |
| orgSlug* | string | |
| clientId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"status": {
"enum": [
"pending",
"confirmed",
"disputed",
"auto_confirmed"
],
"type": "string"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
}
}
}List operational expenses (gastos operacionales) of an organization with their category, plus totals broken down by category type (FIJO/VARIABLE/COSTO_PRODUCTO/PROVISION). Filter by date range (dateFrom/dateTo), category id, type(s), or recurring-only. Read-only — complements finance_list_cobros/finance_list_payments (income side) to complete the financial picture.
| Argument | Type | Description |
|---|---|---|
| tipo | array | |
| limit | integer | |
| apiKey | string | |
| dateTo | string | |
| orgSlug* | string | |
| dateFrom | string | |
| recurrente | boolean | |
| categoriaId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"tipo": {
"type": "array",
"items": {
"enum": [
"FIJO",
"VARIABLE",
"COSTO_PRODUCTO",
"PROVISION"
],
"type": "string"
}
},
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"dateTo": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"dateFrom": {
"type": "string"
},
"recurrente": {
"type": "boolean"
},
"categoriaId": {
"type": "string"
}
}
}List invoices (facturas) of an organization with total, balance (saldo), status, SII status, linked-sales count and the amount already applied via payment links (with a derived payment status: pendiente/abonada/pagada). Filter by client or status (pendiente/pagada/cancelada). Read-only.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| apiKey | string | |
| estado | string | |
| orgSlug* | string | |
| clientId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"estado": {
"enum": [
"pendiente",
"pagada",
"cancelada"
],
"type": "string"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
}
}
}List payments received with filters. Includes summary by payment type.
| Argument | Type | Description |
|---|---|---|
| tipo | string | |
| limit | integer | |
| apiKey | string | |
| cursor | string | |
| dateTo | string | |
| orgSlug* | string | |
| clientId | string | |
| dateFrom | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"tipo": {
"type": "string"
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"cursor": {
"type": "string"
},
"dateTo": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
},
"dateFrom": {
"type": "string"
}
}
}List sales (ventas) for an organization. Filter by client, service, provider, or status.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| apiKey | string | |
| cursor | string | |
| dateTo | string | |
| estado | string | |
| orgSlug* | string | |
| clientId | string | |
| dateFrom | string | |
| servicioId | string | |
| proveedorId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"cursor": {
"type": "string"
},
"dateTo": {
"type": "string"
},
"estado": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
},
"dateFrom": {
"type": "string"
},
"servicioId": {
"type": "string"
},
"proveedorId": {
"type": "string"
}
}
}Register a manual payment against an existing charge (cobro). Updates cobro status automatically. Requires confirm: true.
| Argument | Type | Description |
|---|---|---|
| tipo* | string | |
| fecha | string | |
| monto* | number | |
| apiKey | string | |
| cobroId* | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| descripcion | string | |
| idempotencyKey | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"cobroId",
"monto",
"tipo",
"confirm"
],
"properties": {
"tipo": {
"enum": [
"EFECTIVO",
"TRANSFERENCIA",
"TARJETA",
"MERCADOPAGO",
"OTRO"
],
"type": "string"
},
"fecha": {
"type": "string"
},
"monto": {
"type": "number",
"exclusiveMinimum": 0
},
"apiKey": {
"type": "string"
},
"cobroId": {
"type": "string"
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"descripcion": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
}
}
}Send pending confirmation digest to clients. Groups all pending_confirmation charges by client and sends a single message per client via WhatsApp or email. Creates confirmation tokens and sets a grace period for auto-confirmation. Requires confirm: true.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| channel | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| clientId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"confirm"
],
"properties": {
"apiKey": {
"type": "string"
},
"channel": {
"enum": [
"whatsapp",
"email"
],
"type": "string"
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
}
}
}Get the current lifecycle state of a session, including available transitions, state history, and SC resolution. Returns current_state, available_transitions, verification_deadline (when state=delivered), timestamps, duration, sc_resolution (the fundamental SC event: resolved, resolved_at, resolved_by, billing_model), and recent transition history with from/to/at/by/method fields. Requires X-Org-Api-Key. Shape per docs/protocol/sc-event-canonical-schema-2026-04-18.md §7.1.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| session_id* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"session_id"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"session_id": {
"type": "string"
}
}
}Get the SCEvent stream for a session — all observed transitions reconstructed from status_history. Returns events[] with discriminated union by event_type (sc.scheduled, sc.confirmed, sc.completed, sc.delivered, sc.verified, sc.cancelled, etc.), plus stream_completeness ("complete" | "partial_pre_trigger") and pagination cursor. Events carry origin="reprojected_from_status_history" and canonical SCEvent shape per docs/protocol/sc-event-canonical-schema-2026-04-18.md §7.2. Filters: event_types (e.g. ["sc.delivered"]), from_sequence (cursor), limit (default 50, max 500). PII note: delivery_proof clinical fields (summary, outcome, next_steps) are returned only for admin-scoped keys. IMPORTANT: backfilled sc_resolved timestamps do NOT emit sc.resolved events in this stream (Forma B, see decisions log 2026-04-18-lifecycle-history-backfill-policy). For current resolution status, use lifecycle_get_state.sc_resolution. Requires X-Org-Api-Key.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| apiKey | string | |
| orgSlug* | string | |
| session_id* | string | |
| event_types | array | |
| from_sequence | integer |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"session_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"session_id": {
"type": "string"
},
"event_types": {
"type": "array",
"items": {
"type": "string"
}
},
"from_sequence": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
}
}Execute a state transition on a session. Accepts either to_state (target state name per Servicialo spec: confirmed, in_progress, completed, verified, documented, cancelled, no_show) or action (semantic verb: confirm, start, complete, verify, document, cancel, no_show). When to_state=no_show, no_show_type is required. NOTE: to_state="delivered" / action="deliver" is NOT available via MCP (ref PDC-SEC-001) — MCP authentication cannot validate actor-as-Proveedor. Delivery must be performed via the REST endpoint PATCH /api/organizations/[orgSlug]/coordinalo/sessions/[sessionId]/deliver which enforces provider binding. Returns transition record with from, to, at, by, method fields. Requires X-Org-Api-Key.
| Argument | Type | Description |
|---|---|---|
| notes | string | |
| action | string | |
| apiKey | string | |
| orgSlug* | string | |
| evidence | any | |
| to_state | string | |
| session_id* | string | |
| no_show_type | string | |
| delivery_type |
Invite a new member to the organization by email. Sends an invitation email. Requires confirm: true.
| Argument | Type | Description |
|---|---|---|
| role* | string | |
| email* | string | |
| apiKey | string | |
| confirm* | boolean | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"email",
"role",
"confirm"
],
"properties": {
"role": {
"enum": [
"admin",
"member"
],
"type": "string"
},
"email": {
"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,}$"
},
"apiKey": {
"type": "string"
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
}
}
}List members of an organization with their roles and status.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}Compact organization overview (~500 tokens). Returns services, providers, schedules, active features, key counts, and an onboarding_status checklist showing what is configured vs missing (services, providers, availability, public agenda). Use as first call to orient yourself — cheaper than report_dashboard. If onboarding_status.ready is false, follow the missing steps before booking.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}Update organization profile fields: name, description, logo URL, or vertical. Only provided fields are updated.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| apiKey | string | |
| logoUrl | any | |
| orgSlug* | string | |
| vertical | any | |
| description | any |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"name": {
"type": "string",
"maxLength": 100,
"minLength": 2
},
"apiKey": {
"type": "string"
},
"logoUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"orgSlug": {
"type": "string"
},
"vertical": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
}
}
}Get payroll summary for a period: total per provider, total cost, pending approvals.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| periodo* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"periodo"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"periodo": {
"type": "string"
}
}
}List payroll records for an organization. Filter by period, provider, or status.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| apiKey | string | |
| status | string | |
| orgSlug* | string | |
| periodo | string | |
| providerId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"status": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"periodo": {
"type": "string"
},
"providerId": {
"type": "string"
}
}
}Cancel a pending reschedule request (SessionRequest) on behalf of the client who proposed it — the client-side withdrawal in the bilateral loop (outcome=cancelled_by_client). Idempotent: a request already cancelled_by_client returns wasAlreadyCancelled=true; a request in another terminal state returns a conflict. Use booking_list_requests to find pending requests; use booking_resolve_request for the org's own approve/reject.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| requestId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"requestId"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"requestId": {
"type": "string"
}
}
}Confirm, on behalf of the client, that the service was delivered (writes DeliveryProof.clientConfirmed) — the client-side confirmation that closes dual-confirm verification. Allowed once the session is completed/delivered/documented; rejected if an open dispute exists. Optionally records a 1-5 rating (only if the service captures quality). This is an OVERLAY: it does NOT change session.status (the auto-verify cron advances delivered→verified). Idempotent: alreadyConfirmed=true if already done. Triggers SC resolution.
| Argument | Type | Description |
|---|---|---|
| note | string | |
| apiKey | string | |
| rating | integer | |
| orgSlug* | string | |
| sessionId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"sessionId"
],
"properties": {
"note": {
"type": "string",
"maxLength": 1000
},
"apiKey": {
"type": "string"
},
"rating": {
"type": "integer",
"maximum": 5,
"minimum": 1
},
"orgSlug": {
"type": "string"
},
"sessionId": {
"type": "string"
}
}
}Propose a new time for a session on behalf of the client — opens the bilateral coordination loop by creating a pending SessionRequest (it does NOT move the session; the org resolves it with booking_resolve_request). Provide requestedScheduledAt as an ISO datetime (must be future, within ~3 months). Gated by the org's session-request flow flag and rate-limited per (client, session). The event records the session's client as the proposer. Use booking_list_requests to track pending requests.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| reason | string | |
| orgSlug* | string | |
| sessionId* | string | |
| requestedScheduledAt* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"sessionId",
"requestedScheduledAt"
],
"properties": {
"apiKey": {
"type": "string"
},
"reason": {
"type": "string",
"maxLength": 500
},
"orgSlug": {
"type": "string"
},
"sessionId": {
"type": "string"
},
"requestedScheduledAt": {
"type": "string"
}
}
}Report, on behalf of the client, that the professional did not show up (reason=provider_no_show) or that the session was cancelled/not delivered (reason=cancelled). Creates a Dispute(OPEN) for the org to review — it does NOT change the session status. Idempotent: if an open dispute already exists for the session, returns alreadyReported=true with its disputeId. Notifies the org.
| Argument | Type | Description |
|---|---|---|
| note | string | |
| apiKey | string | |
| reason* | string | |
| orgSlug* | string | |
| sessionId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"sessionId",
"reason"
],
"properties": {
"note": {
"type": "string",
"maxLength": 500
},
"apiKey": {
"type": "string"
},
"reason": {
"enum": [
"provider_no_show",
"cancelled"
],
"type": "string"
},
"orgSlug": {
"type": "string"
},
"sessionId": {
"type": "string"
}
}
}Cancel a client's session on behalf of the client (client-initiated cancellation: cancelledBy=client). Allowed from scheduled/pending_confirmation/confirmed; rejects past sessions. Idempotent: a session already cancelled returns alreadyCancelled=true. Distinct from the admin cancellation with cancellation-policy charges — this is the client-portal cancel flow. The org API key owner is recorded as the actor acting on behalf of the client (ADR-004 §6).
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| sessionId* | string | |
| cancellationReason | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"sessionId"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"sessionId": {
"type": "string"
},
"cancellationReason": {
"type": "string",
"maxLength": 500
}
}
}Confirm a client's attendance to their session, on behalf of the client (e.g. the client called or messaged the org to confirm). Moves scheduled/pending_confirmation → confirmed and notifies the provider. This is the client-portal confirm flow (event role = client), distinct from the org's own admin confirm in booking_update_status. Idempotent: a session already confirmed returns alreadyConfirmed=true. The org API key owner is recorded as the actor acting on behalf of the client (ADR-004 §6).
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| sessionId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"sessionId"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"sessionId": {
"type": "string"
}
}
}Create a new provider in the organization. Links or creates a Person record by email.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| email* | string | |
| phone | string | |
| apiKey | string | |
| orgSlug* | string | |
| lastName* | string | |
| isInternal | boolean | |
| serviceIds | array | |
| idempotencyKey | string | |
| comunasCobertura | array | |
| defaultCommission | number |
Get complete details of a provider including services, schedule, and session stats.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| providerId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"providerId"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"providerId": {
"type": "string"
}
}
}Get detailed performance metrics for a provider over a date range: sessions, occupancy, no-show rate, revenue.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| dateTo | string | |
| orgSlug* | string | |
| dateFrom | string | |
| providerId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"providerId"
],
"properties": {
"apiKey": {
"type": "string"
},
"dateTo": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"dateFrom": {
"type": "string"
},
"providerId": {
"type": "string"
}
}
}Update provider data: status, commission, coverage areas, permissions.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| phone | string | |
| apiKey | string | |
| orgSlug* | string | |
| isActive | boolean | |
| lastName | string | |
| providerId* | string | |
| comunasCobertura | array | |
| defaultCommission | number | |
| canManageOwnServices | boolean | |
| canManageOwnAvailability | boolean |
Query available time slots for public booking. Does NOT require an API key. Returns slots grouped by service from the organization's public agenda. Provider details are hidden — the system auto-assigns at booking time. Use after public_service_list to find bookable times.
| Argument | Type | Description |
|---|---|---|
| date | string | |
| dateTo | string | |
| orgSlug* | string | |
| dateFrom | string | |
| timezone | string | |
| serviceId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"date": {
"type": "string"
},
"dateTo": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"dateFrom": {
"type": "string"
},
"timezone": {
"type": "string"
},
"serviceId": {
"type": "string"
}
}
}Cancel a public booking using the bookingToken. Only works for bookings in pending_confirmation, scheduled, or confirmed status. Optionally include a reason. Does NOT require an API key. The booking token scopes access to a single booking.
| Argument | Type | Description |
|---|---|---|
| reason | string | |
| orgSlug* | string | |
| bookingToken* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"bookingToken"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 500
},
"orgSlug": {
"type": "string"
},
"bookingToken": {
"type": "string",
"minLength": 20
}
}
}Confirm a pending public booking using the confirmationToken returned by public_booking_create. Advances the booking from pending_confirmation to scheduled. The token expires after 30 minutes. Does NOT require an API key. Rate-limited.
| Argument | Type | Description |
|---|---|---|
| orgSlug* | string | |
| confirmationToken* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"confirmationToken"
],
"properties": {
"orgSlug": {
"type": "string"
},
"confirmationToken": {
"type": "string",
"minLength": 20
}
}
}Create a public booking request. Does NOT require an API key, but DOES require: (1) requester identity — fullName plus at least email or phone, (2) submission context — channel and whether an agent assisted, (3) authorization.humanIntentConfirmed must be true. The booking is created as pending_confirmation — use public_booking_confirm with the returned confirmationToken to confirm. A bookingToken is also returned for future lifecycle management (cancel, reschedule). Rate-limited per IP+org. All requests are audited with semantic decision codes. Use public_service_list → public_availability_get_slots → public_booking_create → public_booking_confirm as the complete public booking flow.
| Argument | Type | Description |
|---|---|---|
| notes | string | |
| orgSlug* | string | |
| startAt* | string | |
| requester* | object | |
| serviceId* | string | |
| submission* | object | |
| authorization* | object | |
| idempotencyKey | string |
Get details of a public booking using the bookingToken returned by public_booking_create. Returns status, scheduled time, service, and requester info. Does NOT require an API key — the booking token is the credential. Only returns public-safe data.
| Argument | Type | Description |
|---|---|---|
| orgSlug* | string | |
| bookingToken* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"bookingToken"
],
"properties": {
"orgSlug": {
"type": "string"
},
"bookingToken": {
"type": "string",
"minLength": 20
}
}
}Reschedule a public booking using the bookingToken. Cancels the original and creates a new pending_confirmation booking at the new time. Returns new confirmationToken and bookingToken. Only works for bookings in pending_confirmation, scheduled, or confirmed status. Does NOT require an API key.
| Argument | Type | Description |
|---|---|---|
| orgSlug* | string | |
| newStartAt* | string | |
| bookingToken* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"bookingToken",
"newStartAt"
],
"properties": {
"orgSlug": {
"type": "string"
},
"newStartAt": {
"type": "string"
},
"bookingToken": {
"type": "string",
"minLength": 20
}
}
}List publicly bookable services for an organization. Does NOT require an API key. Returns only active, discoverable services with assigned providers. Use this as the first step in the public booking flow to show available services to end users or agents.
| Argument | Type | Description |
|---|---|---|
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"orgSlug": {
"type": "string"
}
}
}Get the full reminder/notification configuration for an organization. Returns detailed settings for each reminder type: bookingReminder (post-booking follow-up), sessionReminder24h (24h before), sessionReminder1h (1h before), paymentReminder (payment due), paymentOverdue (overdue payment), notificationFollowup (post-session follow-up), pendingConfirmation (auto-cancel unconfirmed). Each has enabled, timing, and frequency settings. More granular than settings_get reminders chapter.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}Update reminder/notification configuration for an organization. Partial update — only provided sections are changed. Sections: bookingReminder {enabled, daysAfter, maxReminders, interval}, sessionReminder24h {enabled, hoursBefore, sendTime}, sessionReminder1h {enabled, hoursBefore}, paymentReminder {enabled, daysAfter, maxReminders, interval}, paymentOverdue {enabled, daysOverdue, maxReminders, interval}, notificationFollowup {enabled, daysAfter, maxFollowups, interval}, pendingConfirmation {enabled, cutoffHours, autoConfirm} (cutoffHours = hours BEFORE the appointment that an unaccepted booking expires). Returns the full configuration after update.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| paymentOverdue | object | |
| bookingReminder | object | |
| paymentReminder | object | |
| sessionReminder1h | object | |
| sessionReminder24h | object | |
| pendingConfirmation | object | |
| notificationFollowup |
Executive summary of the organization: today's sessions, monthly metrics, revenue, pending charges, and alerts.
| Argument | Type | Description |
|---|---|---|
| date | string | |
| apiKey | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"date": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}Real-time report of clients with genuine outstanding debt. Excludes temporal payment mismatches (prepaid clients whose global balance is covered). Shows: client name, debt amount, periods with debt, last payment date, and collection status (active/inactive/never_paid). Use to answer "who actually owes money" questions.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}Adoption and switching evidence for one organization, by month and week: sessions created natively in the app vs imported (count and %), date of the last bulk import, weeks since it, switching level (0 no use / 1 activation / 2 adoption / 3 cutover), no-show rate split by whether a reminder was sent, reminders sent/delivered/confirmed/cancelled, outstanding balance, amount collected after a payment reminder, weekly active staff, and attributable per-org costs (WhatsApp, email, AI tokens) with shared infrastructure prorated separately. Read-only, scoped to the organization of the API key. Use it to answer "is this org actually using the product or still on its spreadsheet". Metrics that cannot be measured today (support events, churn, transfer reconciliation) come back null, never zero.
| Argument | Type | Description |
|---|---|---|
| to | string | |
| from | string | |
| weeks | integer | |
| apiKey | string | |
| format | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"to": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])$"
},
"from": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])$"
},
"weeks": {
"type": "integer",
"maximum": 104,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"format": {
"enum": [
"summary",
"full",
"ev"
],
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}Report no-show statistics for a period. Group by client, provider, service, or day.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| apiKey | string | |
| dateTo | string | |
| groupBy | string | |
| orgSlug* | string | |
| dateFrom | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"dateTo": {
"type": "string"
},
"groupBy": {
"enum": [
"client",
"provider",
"service",
"day"
],
"type": "string"
},
"orgSlug": {
"type": "string"
},
"dateFrom": {
"type": "string"
}
}
}Calculate provider occupancy rates for a period. Group by provider, day, or week.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| dateTo | string | |
| groupBy | string | |
| orgSlug* | string | |
| dateFrom | string | |
| providerId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"dateTo": {
"type": "string"
},
"groupBy": {
"enum": [
"provider",
"day",
"week"
],
"type": "string"
},
"orgSlug": {
"type": "string"
},
"dateFrom": {
"type": "string"
},
"providerId": {
"type": "string"
}
}
}Calculate revenue for a period grouped by day, week, month, service, or provider.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| dateTo | string | |
| groupBy | string | |
| orgSlug* | string | |
| dateFrom | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"dateTo": {
"type": "string"
},
"groupBy": {
"enum": [
"day",
"week",
"month",
"service",
"provider"
],
"type": "string"
},
"orgSlug": {
"type": "string"
},
"dateFrom": {
"type": "string"
}
}
}Breakdown of Servicio Coordinado (SC) events by month and resolver path (backfill, cac-native, live, compensalo). Use to validate SC coverage and monitor live SC resolution growth. Key metric: sc_live shows SCs resolved in production (not backfill).
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| periodo | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"periodo": {
"type": "string"
}
}
}List the bookable resources of an organization (rooms, boxes, chairs, equipment) with their type, capacity, buffer minutes, location and active state. Filter by type, active state, or a name/description search. Read-only.
| Argument | Type | Description |
|---|---|---|
| type | string | |
| limit | integer | |
| apiKey | string | |
| search | string | |
| orgSlug* | string | |
| isActive | boolean |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"type": {
"type": "string"
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"search": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"isActive": {
"type": "boolean"
}
}
}Book a session (Servicialo spec). Returns confirmation_credential (opaque token, valid 30 min) and booking_id. Use scheduling_confirm with the credential to finalize. Does NOT require an API key — uses requester identity (fullName + email or phone). Accepts optional submission context for audit trail.
| Argument | Type | Description |
|---|---|---|
| notes | string | |
| orgSlug* | string | |
| datetime* | string | |
| requester* | object | |
| service_id* | string | |
| submission | object | |
| provider_id | string | |
| idempotencyKey | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"service_id",
"datetime",
"requester"
],
"properties": {
"notes": {
"type": "string",
"maxLength": 500
},
"orgSlug": {
"type": "string"
},
"datetime": {
"type": "string"
},
"requester": {
"type": "object",
"required": [
"fullName"
],
"properties": {
"email": {
"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,}$"
},
"phone": {
"type": "string",
"minLength": 6
},
"fullName": {
"type": "string",
"minLength": 2
},
"nationalId": {
"type": "string"
}
}
},
"service_id": {
"type": "string"
},
"submission": {
"type": "object",
"properties": {
"agentId": {
"type": "string"
},
"channel": {
"enum": [
"web",
"whatsapp",
"phone",
"chat",
"api",
"other"
],
"type": "string",
"default": "api"
},
"platform": {
"type": "string"
},
"agentName": {
"type": "string"
},
"submittedByType": {
"enum": [
"human",
"agent",
"human_with_agent_assistance"
],
"type": "string",
"default": "agent"
}
}
},
"provider_id": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
}
}
}Cancel a session through the Servicialo protocol lane. Moves the session to cancelled and emits sc_service.cancelled.v1. It REPORTS the cancellation policy tier that applies (policy_applied: none | partial | full, with the percentage) but does NOT create any charge — no penalty transaction is persisted and the client owes nothing as a result of this call. If you need the organization lane that actually applies the policy and registers the charge, use booking_cancel instead. Requires confirm: true and X-Org-Api-Key.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| reason | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| session_id* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"session_id",
"confirm"
],
"properties": {
"apiKey": {
"type": "string"
},
"reason": {
"type": "string",
"maxLength": 500
},
"confirm": {
"type": "boolean",
"const": true
},
"orgSlug": {
"type": "string"
},
"session_id": {
"type": "string"
}
}
}Confirm a booking (Servicialo spec). Dual-mode: (1) with credential — uses the confirmation token from scheduling_book, no API key needed; (2) with booking_id — uses API key to confirm an existing session. Returns confirmed status with timestamp.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| booking_id | string | |
| credential | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"booking_id": {
"type": "string"
},
"credential": {
"type": "string",
"minLength": 20
}
}
}Reschedule a session to a new time (Servicialo spec). Cancels the original session and creates a new one at the specified datetime. Requires confirm: true and X-Org-Api-Key.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| confirm* | boolean | |
| orgSlug* | string | |
| session_id* | string | |
| new_datetime* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"session_id",
"new_datetime",
"confirm"
],
"properties": {
"apiKey": {
"type": "string"
},
"confirm": {
"type": "boolean",
"const": true
},
"orgSlug": {
"type": "string"
},
"session_id": {
"type": "string"
},
"new_datetime": {
"type": "string"
}
}
}Assign or unassign a provider to/from a service. Controls which providers can deliver which services.
| Argument | Type | Description |
|---|---|---|
| price | number | |
| action* | string | |
| apiKey | string | |
| confirm | boolean | |
| orgSlug* | string | |
| serviceId* | string | |
| commission | number | |
| providerId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"serviceId",
"providerId",
"action"
],
"properties": {
"price": {
"type": "number",
"minimum": 0
},
"action": {
"enum": [
"assign",
"unassign"
],
"type": "string"
},
"apiKey": {
"type": "string"
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"serviceId": {
"type": "string"
},
"commission": {
"type": "number",
"maximum": 100,
"minimum": 0
},
"providerId": {
"type": "string"
}
}
}Create a new bookable service in an existing organization. Use this for day-to-day service management (requires X-Org-Api-Key). For initial org setup, prefer admin_create_service instead. After creating, use service_assign_provider to link providers. A service without providers cannot accept bookings. Optional delivery-verification overrides per service: verificationLevel (none = silent auto-complete, legacy; default_confirm = both can confirm and silence auto-confirms after the org window; dual_confirm = the client must positively confirm, silence does NOT; documented = the provider must attach evidence) and qualityCapture (ask the client for a 1–5 rating on confirmation). Omit both to inherit the organization defaults.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| price* | number | |
| apiKey | string | |
| orgSlug* | string | |
| category | string | |
| currency | string | |
| duration* | integer | |
| modalidad | string | |
List services of an organization. Can filter by active status, discoverability, or category.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| category | string | |
| activeOnly | boolean | |
| discoverableOnly | boolean |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"category": {
"type": "string"
},
"activeOnly": {
"type": "boolean"
},
"discoverableOnly": {
"type": "boolean"
}
}
}Update an existing service (price, duration, status, etc.). Creates a price history entry if price changes. Delivery-verification overrides can be changed too: verificationLevel (none / default_confirm / dual_confirm / documented — see service_create for semantics) and qualityCapture (1–5 rating on confirmation). Pass null on either to reset that field and inherit the organization default again; omit to leave it unchanged.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| price | number | |
| apiKey | string | |
| orgSlug* | string | |
| category | string | |
| currency | string | |
| duration | integer | |
| isActive | boolean | |
| modalidad | string | |
| serviceId* | string | |
Read the clinical note of a session. Non-restricted notes return full content. Notes marked dataSensitivity=restricted return metadata only (type, sensitivity, timestamps, which fields are present) with the clinical text withheld — pass includeRestricted: true to retrieve the full content, which logs an audited restricted-access event and increments the access counter. Returns note: null if the session has no note.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| sessionId* | string | |
| includeRestricted | boolean |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"sessionId"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"sessionId": {
"type": "string"
},
"includeRestricted": {
"type": "boolean"
}
}
}Create or update the clinical note (ficha) of a session: evolution, treatmentPerformed, nextSessionPlan, type (evaluacion/tratamiento/derivacion/cierre), progressMetrics, etc. One note per session (upsert). Sensitivity is resolved automatically (health-vertical orgs default to restricted). NOTE: unlike the provider's own UI save, this does NOT create the provider-confirmed DeliveryProof nor award practice points — those are provider-bound actions (PDC-SEC-001); use the provider portal / REST for delivery confirmation.
| Argument | Type | Description |
|---|---|---|
| type | any | |
| apiKey | string | |
| orgSlug* | string | |
| evolution | any | |
| isPrivate | boolean | |
| sessionId* | string | |
| dataSensitivity | string | |
| nextSessionPlan | any | |
| treatmentPerformed | any |
Get organization settings. THIS IS THE ENTRY POINT for anything configurable: call it with no filters first to get the full map. Settings are indexed on two axes — `group` (the sections a human sees in the settings screen: profile, availability, client_fields, communication, reminders, automations, finances, delivery, cancellation, tax) and `chapter` (the onboarding-interview sequence: basics, availability, communication, finances, policies, reminders, client_data). Prefer `group`. Or pass `keys` for specific settings (comma-separated, e.g. "policies.noShowMaxStrikes,finances.clientPaymentTiming"). Covers ~88 keys including cancellation-policy tiers, granular reminder timing, dunning sequence, retention, delivery verification and the SII tax profile. The response also carries `meta` (label, type, valid options and dependencies per key) and `panels` — the configuration surfaces that are NOT scalar settings (bank accounts, payment credentials, API keys, members): each panel names the tools that cover it, or states why none does.
| Argument | Type | Description |
|---|---|---|
| keys | string | |
| group | string | |
| apiKey | string | |
| chapter | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"keys": {
"type": "string"
},
"group": {
"enum": [
"profile",
"availability",
"client_fields",
"communication",
"reminders",
"automations",
"finances",
"delivery",
"cancellation",
"tax"
],
"type": "string"
},
"apiKey": {
"type": "string"
},
"chapter": {
"enum": [
"basics",
"availability",
"communication",
"finances",
"policies",
"reminders",
"client_data"
],
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}Update organization settings. Partial update — only provided keys are changed. Pass a settings object with key-value pairs (e.g. {"policies.noShowMaxStrikes": 3, "finances.clientPaymentTiming": "BEFORE"}). ALL values are validated before ANY is written: if one key fails, nothing changes — so related keys can be sent together and either all land or none do. That matters for settings with invariants between them (the cancellation tiers, where the partial-charge window must sit closer to the appointment than the no-charge one) and for the SII tax profile, whose legally required fields must arrive in a single call the first time. Returns the full updated settings for the affected chapters. See settings_get for available keys, valid values and dependencies.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| orgSlug* | string | |
| settings* | object |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"settings"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"settings": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
}
}Get the full detail of a single treatment/care plan by id: diagnosis, objectives, notes, status timeline, expiration, the intake session, and all plan items (service, quantity, frequency, priority, sessions booked/completed). Read-only.
| Argument | Type | Description |
|---|---|---|
| apiKey | string | |
| planId* | string | |
| orgSlug* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"planId"
],
"properties": {
"apiKey": {
"type": "string"
},
"planId": {
"type": "string"
},
"orgSlug": {
"type": "string"
}
}
}List treatment/care plans of an organization with client, provider, status, objectives and their items (services with quantity/frequency/priority). Filter by clientId, status or proveedorId; paginated (page/limit). Read-only — plan creation/editing stays in the UI (requires clinical supervision).
| Argument | Type | Description |
|---|---|---|
| page | integer | |
| limit | integer | |
| apiKey | string | |
| status | string | |
| orgSlug* | string | |
| clientId | string | |
| proveedorId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"apiKey": {
"type": "string"
},
"status": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
},
"proveedorId": {
"type": "string"
}
}
}| string |
| defaultDurations | array |
| showProviderList | boolean |
| assignmentStrategy | string |
| requiresPrepayment | boolean |
| allowGroupSelection | boolean |
| serviceSelectionMode | string |
| providerSelectionMode | string |
| showProviderUtilization | boolean |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"slug"
],
"properties": {
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"isActive": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"description": {
"type": "string"
},
"proveedorId": {
"type": "string"
},
"showSessions": {
"type": "boolean"
},
"showClientNames": {
"type": "boolean"
},
"bookingFlowOrder": {
"enum": [
"service_first",
"provider_first",
"auto"
],
"type": "string"
},
"defaultDurations": {
"type": "array",
"items": {
"type": "number"
}
},
"showProviderList": {
"type": "boolean"
},
"assignmentStrategy": {
"enum": [
"manual",
"round_robin",
"least_booked",
"most_available",
"priority",
"random"
],
"type": "string"
},
"requiresPrepayment": {
"type": "boolean"
},
"allowGroupSelection": {
"type": "boolean"
},
"serviceSelectionMode": {
"enum": [
"required",
"optional",
"auto",
"hidden"
],
"type": "string"
},
"providerSelectionMode": {
"enum": [
"required",
"optional",
"auto",
"hidden"
],
"type": "string"
},
"showProviderUtilization": {
"type": "boolean"
}
}
}| isDefault |
| boolean |
| description | string |
| proveedorId | string |
| showSessions | boolean |
| showClientNames | boolean |
| bookingFlowOrder | string |
| defaultDurations | array |
| showProviderList | boolean |
| assignmentStrategy | string |
| requiresPrepayment | boolean |
| allowGroupSelection | boolean |
| serviceSelectionMode | string |
| providerSelectionMode | string |
| showProviderUtilization | boolean |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"agendaId"
],
"properties": {
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"agendaId": {
"type": "string"
},
"category": {
"type": "string"
},
"isActive": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"expiresAt": {
"type": "string"
},
"isDefault": {
"type": "boolean"
},
"description": {
"type": "string"
},
"proveedorId": {
"type": "string"
},
"showSessions": {
"type": "boolean"
},
"showClientNames": {
"type": "boolean"
},
"bookingFlowOrder": {
"enum": [
"service_first",
"provider_first",
"auto"
],
"type": "string"
},
"defaultDurations": {
"type": "array",
"items": {
"type": "number"
}
},
"showProviderList": {
"type": "boolean"
},
"assignmentStrategy": {
"enum": [
"manual",
"round_robin",
"least_booked",
"most_available",
"priority",
"random"
],
"type": "string"
},
"requiresPrepayment": {
"type": "boolean"
},
"allowGroupSelection": {
"type": "boolean"
},
"serviceSelectionMode": {
"enum": [
"required",
"optional",
"auto",
"hidden"
],
"type": "string"
},
"providerSelectionMode": {
"enum": [
"required",
"optional",
"auto",
"hidden"
],
"type": "string"
},
"showProviderUtilization": {
"type": "boolean"
}
}
}| serviceId | string |
| providerId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"date": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"dateTo": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"agendaId": {
"type": "string"
},
"clientId": {
"type": "string"
},
"dateFrom": {
"type": "string"
},
"duration": {
"type": "integer",
"maximum": 480,
"minimum": 5
},
"timezone": {
"type": "string"
},
"serviceId": {
"type": "string"
},
"providerId": {
"type": "string"
}
}
}| autoCharge |
| boolean |
| providerId | string |
| retroactive | boolean |
| scheduledAt* | string |
| idempotencyKey | string |
| publicAgendaId | string |
| retroactiveStatus | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"clientId",
"serviceId",
"scheduledAt"
],
"properties": {
"notes": {
"type": "string",
"maxLength": 1000
},
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
},
"duration": {
"type": "integer",
"maximum": 480,
"minimum": 5
},
"modalidad": {
"enum": [
"presencial",
"a_domicilio",
"remoto"
],
"type": "string"
},
"serviceId": {
"type": "string"
},
"autoCharge": {
"type": "boolean"
},
"providerId": {
"type": "string"
},
"retroactive": {
"type": "boolean"
},
"scheduledAt": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
},
"publicAgendaId": {
"type": "string"
},
"retroactiveStatus": {
"enum": [
"completed",
"no_show"
],
"type": "string"
}
}
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"clientId",
"providerId",
"recurrence",
"timezone",
"confirm"
],
"properties": {
"notes": {
"type": "string",
"maxLength": 1000
},
"apiKey": {
"type": "string"
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"clientId": {
"type": "string"
},
"timezone": {
"type": "string"
},
"serviceId": {
"type": "string"
},
"providerId": {
"type": "string"
},
"recurrence": {
"type": "object",
"required": [
"startDate",
"startTime",
"duration",
"daysOfWeek",
"endCondition"
],
"properties": {
"duration": {
"type": "integer",
"maximum": 480,
"minimum": 15
},
"startDate": {
"type": "string"
},
"startTime": {
"type": "string"
},
"daysOfWeek": {
"type": "array",
"items": {
"type": "integer",
"maximum": 6,
"minimum": 0
},
"maxItems": 7,
"minItems": 1
},
"endCondition": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"date"
],
"properties": {
"date": {
"type": "string"
},
"type": {
"type": "string",
"const": "until"
}
}
},
{
"type": "object",
"required": [
"type",
"count"
],
"properties": {
"type": {
"type": "string",
"const": "count"
},
"count": {
"type": "integer",
"maximum": 52,
"minimum": 1
}
}
}
]
}
}
},
"skipConflicts": {
"type": "boolean"
}
}
}| string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"name",
"lastName"
],
"properties": {
"rut": {
"type": "string"
},
"name": {
"type": "string",
"minLength": 1
},
"email": {
"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,}$"
},
"notes": {
"type": "string"
},
"phone": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"comuna": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"lastName": {
"type": "string",
"minLength": 1
},
"direccion": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
},
"proveedorTitularId": {
"type": "string"
}
}
}| string |
| emailSubject | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"name",
"emailBody",
"audienceType",
"confirm"
],
"properties": {
"name": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"type": {
"enum": [
"email",
"whatsapp",
"auto"
],
"type": "string",
"default": "email"
},
"apiKey": {
"type": "string"
},
"confirm": {
"type": "boolean"
},
"orgSlug": {
"type": "string"
},
"emailBody": {
"type": "string"
},
"audienceId": {
"type": "string"
},
"adHocFilters": {
"type": "object",
"required": [
"rules",
"operator"
],
"properties": {
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string"
},
"value": {},
"operator": {
"type": "string"
}
}
}
},
"operator": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
}
},
"audienceType": {
"enum": [
"predefined",
"adhoc"
],
"type": "string"
},
"emailSubject": {
"type": "string",
"maxLength": 200
}
}
}| boolean |
| whatsappConfirmationMessage | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"emailEnabled": {
"type": "boolean"
},
"phoneRequired": {
"type": "boolean"
},
"whatsappEnabled": {
"type": "boolean"
},
"emailReminderEnabled": {
"type": "boolean"
},
"phoneRequiredMessage": {
"type": "string"
},
"whatsappReminderEnabled": {
"type": "boolean"
},
"whatsappReminderMessage": {
"type": "string"
},
"emailConfirmationEnabled": {
"type": "boolean"
},
"whatsappConfirmationEnabled": {
"type": "boolean"
},
"whatsappConfirmationMessage": {
"type": "string"
}
}
}| string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"session_id"
],
"properties": {
"notes": {
"type": "string",
"maxLength": 1000
},
"action": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"evidence": {},
"to_state": {
"type": "string"
},
"session_id": {
"type": "string"
},
"no_show_type": {
"enum": [
"client",
"provider"
],
"type": "string"
},
"delivery_type": {
"enum": [
"completo",
"parcial"
],
"type": "string"
}
}
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"name",
"lastName",
"email"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"email": {
"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,}$"
},
"phone": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"lastName": {
"type": "string",
"minLength": 1
},
"isInternal": {
"type": "boolean"
},
"serviceIds": {
"type": "array",
"items": {
"type": "string"
}
},
"idempotencyKey": {
"type": "string"
},
"comunasCobertura": {
"type": "array",
"items": {
"type": "string"
}
},
"defaultCommission": {
"type": "number",
"maximum": 100,
"minimum": 0
}
}
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"providerId"
],
"properties": {
"name": {
"type": "string"
},
"phone": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"isActive": {
"type": "boolean"
},
"lastName": {
"type": "string"
},
"providerId": {
"type": "string"
},
"comunasCobertura": {
"type": "array",
"items": {
"type": "string"
}
},
"defaultCommission": {
"type": "number",
"maximum": 100,
"minimum": 0
},
"canManageOwnServices": {
"type": "boolean"
},
"canManageOwnAvailability": {
"type": "boolean"
}
}
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"serviceId",
"startAt",
"requester",
"submission",
"authorization"
],
"properties": {
"notes": {
"type": "string",
"maxLength": 500
},
"orgSlug": {
"type": "string"
},
"startAt": {
"type": "string"
},
"requester": {
"type": "object",
"required": [
"fullName"
],
"properties": {
"email": {
"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,}$"
},
"notes": {
"type": "string",
"maxLength": 500
},
"phone": {
"type": "string",
"minLength": 6
},
"fullName": {
"type": "string",
"minLength": 2
},
"nationalId": {
"type": "string"
}
}
},
"serviceId": {
"type": "string"
},
"submission": {
"type": "object",
"required": [
"channel",
"submittedByType"
],
"properties": {
"agentId": {
"type": "string"
},
"channel": {
"enum": [
"web",
"whatsapp",
"phone",
"chat",
"api",
"other"
],
"type": "string"
},
"platform": {
"type": "string"
},
"agentName": {
"type": "string"
},
"submittedByType": {
"enum": [
"human",
"agent",
"human_with_agent_assistance"
],
"type": "string"
}
}
},
"authorization": {
"type": "object",
"required": [
"mode",
"humanIntentConfirmed"
],
"properties": {
"mode": {
"enum": [
"human_confirmed",
"delegated_confirmed"
],
"type": "string"
},
"humanIntentConfirmed": {
"type": "boolean",
"const": true
}
}
},
"idempotencyKey": {
"type": "string"
}
}
}| object |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug"
],
"properties": {
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"paymentOverdue": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "integer",
"maximum": 30,
"minimum": 1
},
"daysOverdue": {
"type": "integer",
"maximum": 90,
"minimum": 1
},
"maxReminders": {
"type": "integer",
"maximum": 10,
"minimum": 1
}
}
},
"bookingReminder": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "integer",
"maximum": 30,
"minimum": 1
},
"daysAfter": {
"type": "integer",
"maximum": 30,
"minimum": 1
},
"maxReminders": {
"type": "integer",
"maximum": 10,
"minimum": 1
}
}
},
"paymentReminder": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "integer",
"maximum": 30,
"minimum": 1
},
"daysAfter": {
"type": "integer",
"maximum": 30,
"minimum": 1
},
"maxReminders": {
"type": "integer",
"maximum": 10,
"minimum": 1
}
}
},
"sessionReminder1h": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"hoursBefore": {
"type": "integer",
"maximum": 12,
"minimum": 1
}
}
},
"sessionReminder24h": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"sendTime": {
"type": "string"
},
"hoursBefore": {
"type": "integer",
"maximum": 72,
"minimum": 1
}
}
},
"pendingConfirmation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"autoConfirm": {
"type": "boolean"
},
"cutoffHours": {
"type": "integer",
"maximum": 168,
"minimum": 1
}
}
},
"notificationFollowup": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"interval": {
"type": "integer",
"maximum": 30,
"minimum": 1
},
"daysAfter": {
"type": "integer",
"maximum": 30,
"minimum": 1
},
"maxFollowups": {
"type": "integer",
"maximum": 10,
"minimum": 1
}
}
}
}
}| providerId |
| string |
| description | string |
| isDiscoverable | boolean |
| qualityCapture | any |
| verificationLevel | any |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"name",
"price",
"duration"
],
"properties": {
"name": {
"type": "string"
},
"price": {
"type": "number",
"minimum": 0
},
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"category": {
"type": "string"
},
"currency": {
"type": "string"
},
"duration": {
"type": "integer",
"maximum": 480,
"minimum": 5
},
"modalidad": {
"enum": [
"presencial",
"a_domicilio",
"remoto"
],
"type": "string"
},
"providerId": {
"type": "string"
},
"description": {
"type": "string"
},
"isDiscoverable": {
"type": "boolean"
},
"qualityCapture": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"verificationLevel": {
"anyOf": [
{
"enum": [
"none",
"default_confirm",
"dual_confirm",
"documented"
],
"type": "string"
},
{
"type": "null"
}
]
}
}
}| description |
| string |
| isDiscoverable | boolean |
| qualityCapture | any |
| publicDescription | string |
| verificationLevel | any |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"serviceId"
],
"properties": {
"name": {
"type": "string"
},
"price": {
"type": "number",
"minimum": 0
},
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"category": {
"type": "string"
},
"currency": {
"type": "string"
},
"duration": {
"type": "integer",
"maximum": 480,
"minimum": 5
},
"isActive": {
"type": "boolean"
},
"modalidad": {
"enum": [
"presencial",
"a_domicilio",
"remoto"
],
"type": "string"
},
"serviceId": {
"type": "string"
},
"description": {
"type": "string"
},
"isDiscoverable": {
"type": "boolean"
},
"qualityCapture": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"publicDescription": {
"type": "string"
},
"verificationLevel": {
"anyOf": [
{
"enum": [
"none",
"default_confirm",
"dual_confirm",
"documented"
],
"type": "string"
},
{
"type": "null"
}
]
}
}
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"orgSlug",
"sessionId"
],
"properties": {
"type": {
"anyOf": [
{
"enum": [
"evaluacion",
"tratamiento",
"derivacion",
"cierre"
],
"type": "string"
},
{
"type": "null"
}
]
},
"apiKey": {
"type": "string"
},
"orgSlug": {
"type": "string"
},
"evolution": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"isPrivate": {
"type": "boolean"
},
"sessionId": {
"type": "string"
},
"dataSensitivity": {
"enum": [
"public",
"internal",
"confidential",
"restricted"
],
"type": "string",
"default": "internal"
},
"nextSessionPlan": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"treatmentPerformed": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
}