API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · activities

Activity Schema

Schema-ID
activity
Collection
activities
Permissions
  • Lesenactivity_view
  • Anlegenactivity_create
  • Ändernactivity_edit
  • Löschenactivity_delete

Felder

Activity Schema

activities4 Permissions

Schema for universal communication/activity log entries

activityTypestringerforderlich

Type of activity

MEETINGCALLEMAILNOTEDOCUMENTSTATUS_CHANGEOTHER
subjectstringerforderlich

Activity subject/title

1–500 Zeichen
bodystringoptional

Activity description/notes (plain text or markdown)

max 200000 Zeichennullable
htmlBodystringoptional

Rich text body (HTML)

nullable
occurredAtdatetimeerforderlich

When the activity occurred (ISO 8601)

durationMinutesintegeroptional

Duration in minutes (for meetings, calls)

≥ 0nullable
directionstringoptional

Communication direction (for calls/emails)

INBOUNDOUTBOUND
nullable
partyIduuidoptional

Linked company/organization (for CRM timeline)

nullable
contactPartyIduuidoptional

Linked contact person

nullable
performedByIduuidoptional

User who performed the activity

nullable
participantIdsuuid[]optional

Internal user participants

Default: []nullable
externalParticipantsobject[]optional

External attendees (name + contact info)

Default: []nullable
namestringerforderlich
1–200 Zeichen
emailstringoptional
max 254 Zeichennullable
phonestringoptional
max 50 Zeichennullable
isInternalbooleanoptional

Marks an internal activity (e.g. internal meeting). Internal activities are hidden from customer-facing/external activity feeds.

Default: falsenullable
entityTypestringoptional

Primary linked entity type (e.g. project, ticket, opportunity)

nullable
entityIduuidoptional

Primary linked entity ID

nullable
linkedEntitiesobject[]optional

Additional linked entities beyond the primary

Default: []nullable
entityTypestringerforderlich
min 1 Zeichen
entityIduuiderforderlich
rolestringoptional
max 100 Zeichennullable
sourceTypestringoptional

How this activity was created

manualphone_callcalendar_eventemail_messagesystem
nullable
sourceEntityIduuidoptional

ID of the source entity that generated this activity

nullable
outcomestringoptional

Outcome/result of the activity

max 1000 Zeichennullable
followUpDatedatetimeoptional

Scheduled follow-up date

nullable
tagsstring[]optional

Tags

Default: []nullable
followUpTaskIduuidoptional

UUID of the task that was auto-created from `followUpDate`. The dialog syncs this task (title/dueDate/cancellation) whenever the activity is saved. Cleared when the user removes the follow-up date.

nullable
attachmentsobject[]optional

File attachments

Default: []nullable
fileIdstringerforderlich
fileNamestringerforderlich
mimeTypestringoptional
sizeBytesintegeroptional
customerSentimentstringoptional

Captured customer sentiment for this interaction. Feeds the Customer Health Score.

positiveneutralnegativenull
nullable
customerRatingintegeroptional

Customer satisfaction rating (1–5 stars). Feeds the Customer Health Score.

1 – 5nullable
feedbackNotestringoptional

Free-text note accompanying customer sentiment/rating

max 1000 Zeichennullable
sentimentSourcestringoptional

Whether sentiment was captured manually or detected by AI

manualai_detectednull
nullable
aiSentimentConfidencenumberoptional

Confidence score 0–1 for AI-detected sentiment (Phase 2)

0 – 1nullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/activities — Liste, paginiert + filterbar
  • GET /api/v1/activities/<id> — Einzelne Entity
  • POST /api/v1/activities — Anlegen
  • PATCH /api/v1/activities/<id> — Teil-Update
  • DELETE /api/v1/activities/<id> — Soft-Delete
  • GET /api/v1/activities/<id>/timeline — Audit + Aktivitäten

Suche