Activity
/api/v1/crm/activitiesA logged interaction (call, meeting, email).
listgetcreateSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| account_id | string | Account this activity is logged against. At least one of accountId, dealId, contactId must be set. |
| deal_id | string | Deal this activity is logged against. |
| contact_id | string | Primary contact involved in this activity. |
| contact_ids | json | All contacts present in this activity. |
| activity_type | string | Type of touchpoint. |
| subject | string | Short subject or title of the activity. |
| description | string | Detailed notes. Markdown allowed. |
| activity_date | date-time | When the activity happened. |
| due_date | date-time | Due date for task-type activities. |
| completed_at | date-time | Timestamp when the activity was completed. |
| status | string | Lifecycle status of this activity. |
| priority | string | Priority of this activity. |
| direction | string | Communication direction, applicable for calls and emails. |
| outcome | string | Outcome of the activity. |
| actor_type | string | Who or what performed this activity. |
| performed_by_user_id | string | User ID of the person or service account that performed this activity. |
| participants | json | All participants in this activity (users and contacts). |
| linked_trace_id | string | Trace ID if this activity was AI-authored; references the Telemetry Trace entity. |
| attachment_refs | json | MinIO object keys for attached files. |
| recurrence | json | Recurrence schedule for repeating activities. |
| reminder_sent | boolean | Whether a reminder notification has been sent for this activity. |
| custom_fields | json | Per-tenant schema extension (e.g. gongCallId, duration_minutes). |
| tags | json | Free-form string tags. |
| version | number | Optimistic-concurrency version counter. |
| type | enum | call | email | meeting | note | taskShort activity type classification. |
| owner_id | uuid | User who owns this activity. Format: usr-<uuid>. |
| notes | string | Free-text notes on the activity. |
| occurred_at | date-time | When the activity occurred. |
API
client.customer.activities.*Loading manifest…