ConnectCloud Developers

List activities (tenant:crm:read)

GET /api/crm/v1/activities

Module: CRM · operationId: listActivities · Tag: Activities · Auth: access token (Authorization: Bearer <accessToken>)

Tasks (kind=TASK or open=true) are sorted by dueAt, everything else newest first, unless sort says otherwise.

Parameters

Name In Type Required Description
leadId query string (uuid)
opportunityId query string (uuid)
addressId query string (uuid)
campaignId query string (uuid)
kind query ActivityKind (one of NOTE, CALL, MEETING, EMAIL, TASK, SYSTEM)
assignee query string Assignee e-mail address, or me. (max length 255)
open query boolean true: only tasks that are not done; false: only done ones.
dueBefore query string (date-time) Only tasks due before this time (RFC 3339).
sort query string Sort order: a field for ascending, -field for descending. Fields: createdAt, dueAt, updatedAt. Default -createdAt; dueAt for tasks. Unknown values answer 400 (invalid_sort). (max length 32)
limit query integer Page size, 1–200 (default 50); any other value is 400 invalid. (default 50; max 200)
cursor query string nextCursor of the previous page; leave out for the first page. Keep sort and the filters unchanged while paging: a cursor of another sort or an altered one is 400 invalid (field: cursor). (max length 1024)

Responses

  • 200 A page of activities and the total number of matching ones (application/json)
  • 400 Invalid input (invalid): field names the first invalid field, details.fields every one (JSON paths for bodies, parameter names for the query). Some refusals have their own code (invalid_sort, invalid_stages, invalid_custom_fields, convert_target_required, invalid_csv, …). (application/json)
  • 401 Missing, invalid or expired token (no body).
  • 403 The token lacks the permission (insufficient permissions) or has no active tenant. (application/json)
  • 500 Unexpected error; details are only logged. (application/json)

Fields of the 200 answer:

  • items (array of Activity, required): One page of activities.
    • bookedMinutes (integer, nullable, required, read-only): Work HR booked on the activity (subject crm:activity:<id>, worked minus breaks, ADR 0040); filled by GET /activities/{id} and the activity list, null there when HR does not answer (never an error) and in answers of writes.
    • createdAt (string (date-time), required): Creation time.
    • customerNo (string, required): Customer number of the tenant.
    • id (string (uuid), required): Id of the activity.
    • kind (ActivityKind, required): SYSTEM entries are history written by the CRM and cannot be created or changed. (one of NOTE, CALL, MEETING, EMAIL, TASK, SYSTEM)
    • meta (object, required): Details of SYSTEM entries (for example the old and new stage); of a tracked interaction interactionId, provider, summary and transcript (left out by lists); empty otherwise.
    • subject (string, required): Subject (one line).
    • tenantName (string, required): Tenant name.
    • updatedAt (string (date-time), required): Time of the last change.
    • addressId (string (uuid)): Masterdata address the activity belongs to; omitted when not set.
    • assigneeEmail (string): Employee the task is assigned to.
    • body (string): Omitted when not set (and after anonymisation).
    • campaignId (string (uuid)): Campaign the activity belongs to; omitted when not set.
    • createdBy (string): E-mail of the creating person; omitted for system entries.
    • createdByName (string): Name of the creating person; omitted when not known.
    • doneAt (string (date-time), read-only): Completion time of a task.
    • doneBy (string, read-only): Who completed the task.
    • dueAt (string (date-time)): Due date of a task.
    • interactionId (string (uuid), read-only): The comms interaction a tracked call or meeting records.
    • leadId (string (uuid)): Lead the activity belongs to; omitted when not set.
    • opportunityId (string (uuid)): Opportunity the activity belongs to; omitted when not set.
    • recordName (string, read-only): Title of the opportunity, else company of the lead the activity belongs to; set by the activity list only.
  • total (integer, required): Number of all records matching the filters.
  • nextCursor (string): Cursor of the next page (pass it as cursor); missing on the last page.

Example 200 answer:

{
  "items": [
    {
      "assigneeEmail": "lena.vogel@muster-it.example",
      "body": "Frau Gaßner wollte die Freigabe des Budgets mit dem Gesellschafter klären.",
      "bookedMinutes": 25,
      "createdAt": "2026-11-12T16:45:00Z",
      "createdBy": "lena.vogel@muster-it.example",
      "createdByName": "Lena Vogel",
      "customerNo": "99999",
      "dueAt": "2026-11-20T09:00:00Z",
      "id": "1d3f5b7d-9e1a-4c3d-8f5b-9a1c3e5b7d9f",
      "kind": "TASK",
      "leadId": "5b7d9f1a-3c5e-4a7b-9d1f-3a5c7e9b1d3f",
      "meta": {},
      "opportunityId": "7d9f1b3d-5e7a-4c9b-8f1d-5c7e9a1b3d5f",
      "recordName": "WLAN Sudhaus und Lager",
      "subject": "Angebot WLAN Sudhaus nachfassen",
      "tenantName": "DEMO",
      "updatedAt": "2026-11-12T16:45:00Z"
    }
  ],
  "total": 1
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/crm/v1/activities' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI