CRM API

The CRM API enables you to inspect organization-level pipeline velocity, retrieve real-time operational dashboard metrics, and orchestrate customer follow-up tasks linked to contacts and team members.

+---------------------------------------------------------------------------------+
|                               Sayvy AI CRM System                               |
|                                                                                 |
|  +-------------------------+         +---------------------------------------+  |
|  |   Executive Dashboard   |         |           Task Orchestration          |  |
|  |  * Pipeline Stages      |         |  * Follow-up Actions & Reminders      |  |
|  |  * AI vs Human Ratio    |         |  * Contact Linkage & Team Assignment  |  |
|  |  * Pending & Overdue    |         |  * State Transitions (Done/Cancelled) |  |
|  +------------+------------+         +-------------------+-------------------+  |
|               |                                          |                      |
|               v                                          v                      |
|  +---------------------------------------------------------------------------+  |
|  |                         Contact Activity Timeline                         |  |
|  |          (task_created, task_completed, stage_changed, notes)            |  |
|  +---------------------------------------------------------------------------+  |
+---------------------------------------------------------------------------------+

Key Capabilities

Aggregated Dashboard Analytics

Retrieve real-time metrics summarizing contacts by lifecycle stage, AI vs human handling workloads, and overdue tasks in a single query.

Task Orchestration

Assign action items and follow-ups to team members, complete with due dates and contact linkages.

Lifecycle Tracking

Track deals as they progress from new to engaged, qualified, customer, or lost.

Audit & Event Integration

Creating or completing a task automatically appends an event to the contact’s activity history for complete organizational visibility.

Task Model Schema

Tasks in Sayvy AI represent follow-up obligations linked to a specific customer contact:

Field	Type	Description
`id`	`UUID`	Unique identifier of the task.
`organization_id`	`UUID`	Owning organization identifier.
`contact_id`	`UUID`	Associated contact UUID.
`title`	`string`	Task title or subject (1–255 characters).
`description`	`string`	Detailed notes or instructions for the task, or `null`.
`due_at`	`string`	ISO 8601 datetime when the task is due, or `null`.
`assignee_id`	`UUID`	User UUID assigned to execute this task, or `null`.
`status`	`string`	Task state: `pending`, `completed`, or `cancelled`.
`created_by_type`	`string`	Creator actor type: `user`, `ai`, or `system`.
`created_by_id`	`UUID`	Identifier of the user or agent creator, or `null`.
`completed_at`	`string`	ISO 8601 timestamp when status changed to `completed`, or `null`.
`created_at`	`string`	ISO 8601 creation timestamp.
`updated_at`	`string`	ISO 8601 modification timestamp.
`contact`	`object`	Lightweight summary of the associated contact (`id`, `name`, `phone_number`).

Available Endpoints

Method	Endpoint	Description
GET	`/api/v1/crm/dashboard`	Retrieve aggregated pipeline, handling, and task metrics
GET	`/api/v1/crm/tasks`	List and filter tasks by status, contact, assignee, or due dates
POST	`/api/v1/crm/tasks`	Create a new task linked to a contact
GET	`/api/v1/crm/tasks/{task_id}`	Retrieve a single task by ID
PATCH	`/api/v1/crm/tasks/{task_id}`	Update task details, reassign, or transition status
DELETE	`/api/v1/crm/tasks/{task_id}`	Permanently delete a task

‹ Previous (Contacts)

CRM Dashboard

GET /api/v1/crm/dashboard

Next ›

Overview

Agents

Campaigns

Contacts

CRM

Templates

Knowledge Base

Webhooks

Call Logs

Quick Replies

Inbox

CRM Overview

CRM API

Key Capabilities

Aggregated Dashboard Analytics

Task Orchestration

Lifecycle Tracking

Audit & Event Integration

Task Model Schema

Available Endpoints

​CRM API

​Key Capabilities

Aggregated Dashboard Analytics

Task Orchestration

Lifecycle Tracking

Audit & Event Integration

​Task Model Schema

​Available Endpoints

CRM API

Key Capabilities

Task Model Schema

Available Endpoints