Vixiees Client API ## Sections • [Vixiees API](https://developers.vixiees.com/vixiees-api.md): Welcome to the Vixiees API The Vixiees API allows you to securely and efficiently integrate your systems with our platform, automate processes and… • [Call Recordings](https://developers.vixiees.com/call-recordings.md): Access call recordings • [Retrieves call recordings](https://developers.vixiees.com/call-recordings/retrieves-call-recordings.md): Returns a paginated list of call recordings with transcription status. Each recording includes an encrypted_url for secure playback access. Filter by… • [Contacts](https://developers.vixiees.com/contacts.md): Manage contacts (leads and clients) • [Retrieves contacts](https://developers.vixiees.com/contacts/retrieves-contacts.md): Returns a paginated list of contacts. Use filters to narrow results: words : Full-text search across name, email, phone, company exactsearch : Exact… • [Creates a new contact](https://developers.vixiees.com/contacts/creates-a-new-contact.md): Creates a new contact. At least one of email or phone is required for WhatsApp/email communication. Optionally assign the contact to a playbook, flow… • [Retrieves documents for a contact](https://developers.vixiees.com/contacts/retrieves-documents-for-a-contact.md): Returns all files attached to the contact (PDFs, images, etc.). Each document includes a secure url for downloading the file. • [Uploads a document to a contact](https://developers.vixiees.com/contacts/uploads-a-document-to-a-contact.md): Uploads a file to the contact. Maximum file size is 35MB. Use the tag parameter to categorize documents (e.g., “contract”, “id”, “invoice”). • [Retrieves the activity feed for a contact](https://developers.vixiees.com/contacts/retrieves-the-activity-feed-for-a-contact.md): Returns a paginated activity feed for a contact, including calls (regular and WhatsApp), comments, tasks, emails, SMS messages, and other events.… • [Retrieves whatsapp conversations for a contact](https://developers.vixiees.com/contacts/retrieves-whatsapp-conversations-for-a-contact.md): Returns the WhatsApp conversation history for a contact. Messages include media URLs for attachments (images, documents, audio, video). Both sent and… • [Retrieves a specific contact](https://developers.vixiees.com/contacts/retrieves-a-specific-contact.md): Returns a single contact with all fields including custom attributes. You can use either the internal ID or the externalreferenceid to retrieve the… • [Deletes a contact](https://developers.vixiees.com/contacts/deletes-a-contact.md): Deletes a contact. All associated tasks and deals will be preserved but no longer visible in the app. • [Updates a contact](https://developers.vixiees.com/contacts/updates-a-contact.md): Partial update of a contact. Only provided fields are modified; omitted fields remain unchanged. Custom attributes can be updated by including them… • [Adds a comment to a contact](https://developers.vixiees.com/contacts/adds-a-comment-to-a-contact.md): Adds a comment to a contact’s activity feed. Comments are visible in the contact timeline and can be synced to integrated CRMs (Hubspot, Pipedrive). • [Assigns a user to a contact](https://developers.vixiees.com/contacts/assigns-a-user-to-a-contact.md): Assigns a team member to be the owner of this contact. The assigned user will see this contact in their task queue and receive notifications. • [Updates a contact's current playbook](https://developers.vixiees.com/contacts/updates-a-contact-s-current-playbook.md): Moves a contact to a different playbook and/or flow step. Use this to progress contacts through your sales pipeline or reassign them to different… • [Contracts](https://developers.vixiees.com/contracts.md): Contract documents • [Retrieves contracts](https://developers.vixiees.com/contracts/retrieves-contracts.md): Returns a paginated list of contract documents. Contracts track agreements with clients including status, start/end dates. • [Dashboard](https://developers.vixiees.com/dashboard.md): Analytics dashboard data export • [Retrieves dashboard leaderboard](https://developers.vixiees.com/dashboard/retrieves-dashboard-leaderboard.md): Returns per-agent performance metrics for a given playbook and time period. Includes contact metrics, task metrics, call metrics, WhatsApp metrics,… • [Retrieves dashboard overview stats](https://developers.vixiees.com/dashboard/retrieves-dashboard-overview-stats.md): Returns aggregated KPI metrics for a given playbook and time period. Each metric includes current value, previous period value, and the difference. • [Retrieves dashboard tasks distribution](https://developers.vixiees.com/dashboard/retrieves-dashboard-tasks-distribution.md): Returns task data for a given playbook, including summary cards, hourly distribution, and a breakdown by user and task type. Each breakdown entry… • [Retrieves all playbook value dashboard data in one request](https://developers.vixiees.com/dashboard/retrieves-all-playbook-value-dashboard-data-in-one-request.md): Returns playbook value dashboard data in a single request: salesperson rows with flow step breakdown, global totals, and flow step metadata ordered… • [Retrieves dashboard flow step transitions](https://developers.vixiees.com/dashboard/retrieves-dashboard-flow-step-transitions.md): Returns contact transitions between flow steps (estados) for a given playbook and date range. Each entry shows the source state, destination state,… • [Deals](https://developers.vixiees.com/deals.md): Track sales opportunities • [Retrieves deals](https://developers.vixiees.com/deals/retrieves-deals.md): Returns a paginated list of deals. Filter by contact, assignee, status, amount range, or creation/update/close date range. Query params that are not… • [Creates a new deal](https://developers.vixiees.com/deals/creates-a-new-deal.md): Creates a new deal linked to a contact. A deal tracks a sales opportunity with an optional amount and description. contactid accepts either the… • [Retrieves a deal](https://developers.vixiees.com/deals/retrieves-a-deal.md): Returns a single deal with all fields, including its custom attributes. You can use either the internal ID or the externalreferenceid to retrieve the… • [Updates a deal](https://developers.vixiees.com/deals/updates-a-deal.md): Updates a deal’s amount, status, close date, or other fields. Only provided fields are modified; omitted fields remain unchanged. You can use either… • [Deletes a deal](https://developers.vixiees.com/deals/deletes-a-deal.md): Deletes a deal. You can use either the internal ID or the externalreferenceid to identify the deal. • [Playbooks](https://developers.vixiees.com/playbooks.md): Sales workflow definitions • [Retrieves all playbooks](https://developers.vixiees.com/playbooks/retrieves-all-playbooks.md): Returns all playbooks (sales workflows) for the account. Playbooks define the stages (flow steps) that contacts progress through. Use the playbook ID… • [Flow Steps](https://developers.vixiees.com/flow-steps.md): Stages within playbooks • [Retrieves flow steps for a playbook](https://developers.vixiees.com/flow-steps/retrieves-flow-steps-for-a-playbook.md): Returns all stages (flow steps) within a playbook. Flow steps represent the progression stages for contacts (e.g., “New Lead”, “Qualified”,… • [Sales Dashboard](https://developers.vixiees.com/sales-dashboard.md): Per-agent sales dashboard data export • [Retrieves sales dashboard performance data for a single agent](https://developers.vixiees.com/sales-dashboard/retrieves-sales-dashboard-performance-data-for-a-single-agent.md): Returns performance data for one agent on a playbook: KPI cards (won, conversion_rate, tasks, contacted) with team tier badge for the given time… • [Retrieves daily sales goals and their goal/actual records](https://developers.vixiees.com/sales-dashboard/retrieves-daily-sales-goals-and-their-goal-actual-records.md): Returns the playbook’s daily sales goals (target per metric: new leads, won deals) and the daily goal/actual records for those metrics within the… • [Submitted Forms](https://developers.vixiees.com/submitted-forms.md): Lead capture forms • [Retrieves submitted forms](https://developers.vixiees.com/submitted-forms/retrieves-submitted-forms.md): Returns a paginated list of submitted lead capture forms. Forms can come from multiple sources: web forms, Meta (Facebook) lead ads, or Typeform.… • [Retrieves a submitted form](https://developers.vixiees.com/submitted-forms/retrieves-a-submitted-form.md): Returns a single submitted form with all responses and metadata. • [Task Templates](https://developers.vixiees.com/task-templates.md): Task template definitions • [Retrieves task templates](https://developers.vixiees.com/task-templates/retrieves-task-templates.md): Returns all task templates defined for the account. Task templates define the types of follow-up actions (e.g., “First Call”, “Demo Meeting”). Use… • [Tasks](https://developers.vixiees.com/tasks.md): Manage follow-up tasks • [Retrieves tasks](https://developers.vixiees.com/tasks/retrieves-tasks.md): Returns a paginated list of tasks. Filter by assignee, contact, or status. Tasks represent follow-up actions for contacts (calls, meetings, etc.). • [Creates a new task](https://developers.vixiees.com/tasks/creates-a-new-task.md): Creates a new task for contact follow-up. Tasks are based on task templates which define the type of follow-up action. Optionally schedule the task… • [Cancels a task](https://developers.vixiees.com/tasks/cancels-a-task.md): Marks a task as cancelled. The task will no longer appear in the task queue. • [Completes a task](https://developers.vixiees.com/tasks/completes-a-task.md): Marks a task as completed. Records the completion time and removes it from the task queue. • [WhatsApp Templates](https://developers.vixiees.com/whatsapp-templates.md): Send WhatsApp messages • [Retrieves WhatsApp templates](https://developers.vixiees.com/whatsapp-templates/retrieves-whatsapp-templates.md): Returns all approved WhatsApp Business templates for the account. Only templates with status: approved can be used to send messages. Templates are… • [Sends a WhatsApp template message](https://developers.vixiees.com/whatsapp-templates/sends-a-whatsapp-template-message.md): Sends a WhatsApp template message to a contact. Use bodyparameters to fill the template’s body variables ( {{1}} , {{2}} , …). It is positional — the… • [Webhooks](https://developers.vixiees.com/webhooks.md): Receive real-time events • [Webhooks](https://developers.vixiees.com/webhooks/webhooks-1.md): Receive webhook events. All events POST to this single path. See multiple examples below. • [Webhooks example: contact_comment_created](https://developers.vixiees.com/webhooks/webhooks-example-contact_comment_created.md): Example only. Actual endpoint path is /webhooks. Use YOUR WEBHOOK URL; only the body varies. • [Webhooks example: contact_created](https://developers.vixiees.com/webhooks/webhooks-example-contact_created.md): Example only. Actual endpoint path is /webhooks. Use YOUR WEBHOOK URL; only the body varies. • [Webhooks example: contact_deleted](https://developers.vixiees.com/webhooks/webhooks-example-contact_deleted.md): Example only. Actual endpoint path is /webhooks. Use YOUR WEBHOOK URL; only the body varies. • [Webhooks example: contact_updated](https://developers.vixiees.com/webhooks/webhooks-example-contact_updated.md): Example only. Actual endpoint path is /webhooks. Use YOUR WEBHOOK URL; only the body varies. • [Webhooks example: deal_updated](https://developers.vixiees.com/webhooks/webhooks-example-deal_updated.md): Example only. Actual endpoint path is /webhooks. Use YOUR WEBHOOK URL; only the body varies. • [Webhooks example: document_created](https://developers.vixiees.com/webhooks/webhooks-example-document_created.md): Example only. Actual endpoint path is /webhooks. Use YOUR WEBHOOK URL; only the body varies. • [Webhooks example: incoming_call](https://developers.vixiees.com/webhooks/webhooks-example-incoming_call.md): Example only. Actual endpoint path is /webhooks. Use YOUR WEBHOOK URL; only the body varies. • [Webhooks example: submitted_form_created](https://developers.vixiees.com/webhooks/webhooks-example-submitted_form_created.md): Example only. Actual endpoint path is /webhooks. Use YOUR WEBHOOK URL; only the body varies. • [Webhooks example: task_completed](https://developers.vixiees.com/webhooks/webhooks-example-task_completed.md): Example only. Actual endpoint path is /webhooks. Use YOUR WEBHOOK URL; only the body varies. • [Webhooks example: whatsapp_received](https://developers.vixiees.com/webhooks/webhooks-example-whatsapp_received.md): Example only. Actual endpoint path is /webhooks. Use YOUR WEBHOOK URL; only the body varies.