@hailer/mcp 0.0.1

package/.claude/skills/activity-api/references/activity-endpoints.md

@@ -0,0 +1,845 @@
+# Activity API Endpoints Reference
+
+Complete reference for Hailer Activity API endpoints (v2 and v3).
+
+## Table of Contents
+
+### V2 Endpoints
+- [v2.activities.copy](#v2activitiescopy) - Copy activities
+- [v2.activities.expired](#v2activitiesexpired) - Query expired activities
+- [v2.activities.events](#v2activitiesevents) - Activity events
+- [v2.activities.timeline](#v2activitiestimeline) - Timeline view
+- [v2.activities.files](#v2activitiesfiles) - Activity files
+- [v2.activities.list](#v2activitieslist) - List activities
+- [v2.activities.kanban.load](#v2activitieskanbanload) - Load kanban activity
+- [v2.activities.kanban.list](#v2activitieskanbanlist) - Kanban list
+- [v2.activities.count.linked](#v2activitiescountlinked) - Count linked activities
+- [v2.activities.removeFollower](#v2activitiesremovefollower) - Remove follower
+- [v2.activities.updatePriority](#v2activitiesupdatepriority) - Update priority
+- [v2.activities.evaluate](#v2activitiesevaluate) - Evaluate function field
+- [v2.activities.evaluateDependencies](#v2activitiesevaluatedependencies) - Dependency graph
+- [v2.activities.dependentFields](#v2activitiesdependentfields) - Get dependent fields
+- [v2.activities.nameIsUnique](#v2activitiesnameisunique) - Check name uniqueness
+
+### V3 Endpoints
+- [v3.activity.timeline2](#v3activitytimeline2) - Timeline view v2
+- [v3.activity.count](#v3activitycount) - Count activities
+- [v3.activity.create](#v3activitycreate) - Create single activity
+- [v3.activity.createMany](#v3activitycreatemany) - Create multiple activities
+- [v3.activity.updateMany](#v3activityupdatemany) - Update multiple activities
+- [v3.activity.evaluateMany](#v3activityevaluatemany) - Evaluate multiple function fields
+- [v3.activity.permissions](#v3activitypermissions) - Check permissions
+- [v3.activity.template.create](#v3activitytemplatecreate) - Get activity template
+- [v3.activity.linkedFrom.overview](#v3activitylinkedfromoverview) - Linked activities overview
+- [v3.activity.linkedFrom.search](#v3activitylinkedfromsearch) - Search linked activities
+- [v3.activity.linkedFrom.next](#v3activitylinkedfromnext) - Next linked activities
+- [v3.activity.linkedFrom.refresh](#v3activitylinkedfromrefresh) - Refresh linked activities
+- [v3.activity.removed.overview](#v3activityremovedoverview) - List deleted activities
+- [v3.activity.removed.more](#v3activityremovedmore) - More deleted activities
+- [v3.activity.removed.recover](#v3activityremovedrecover) - Recover deleted activities
+- [v3.activity.import](#v3activityimport) - Import activities
+- [v3.activity.list](#v3activitylist) - List activities (v3)
+- [v3.activity.events](#v3activityevents) - Activity events (v3)
+- [v3.activity.timeline](#v3activitytimeline) - Timeline with filtering
+- [v3.activity.kanban.load](#v3activitykanbanload) - Load kanban activity
+- [v3.activity.kanban.list](#v3activitykanbanlist) - Kanban list
+
+---
+
+## V2 Endpoints
+
+### v2.activities.copy
+
+Creates copies of activities provided in an array. The resulting activities will all be called 'Copy of ...' unless otherwise specified in the rename object within the second parameter. The values in any given field will be kept for all fields used in the initial phase of the workflow.
+
+**Endpoint**: `POST /v2/activities/copy`
+
+**Request Body**:
+```json
+{
+  "0": ["activityId1", "activityId2"],  // Array of 24-char activityIds
+  "1": {
+    "workspaceId": "stringstringstringstring",  // Optional
+    "advanced": false,
+    "rename": {
+      "activityId1": "New Name"  // Optional rename mapping
+    }
+  }
+}
+```
+
+**Response**:
+```json
+{
+  "code": 0,
+  "msg": "string",
+  "details": {},
+  "debug": null
+}
+```
+
+---
+
+### v2.activities.expired
+
+**Endpoint**: `POST /v2/activities/expired`
+
+**Request Body**:
+```json
+{
+  "0": {
+    "processes": [],
+    "phases": []
+  }
+}
+```
+
+---
+
+### v2.activities.events
+
+**Endpoint**: `POST /v2/activities/events`
+
+**Request Body**:
+```json
+{
+  "0": {
+    "dates": {},
+    "filter": {}
+  }
+}
+```
+
+---
+
+### v2.activities.timeline
+
+**Endpoint**: `POST /v2/activities/timeline`
+
+**Request Body**:
+```json
+{
+  "0": {
+    "dateFieldId": "stringstringstringstring",
+    "dates": {},
+    "groupByFieldId": "stringstringstringstring",
+    "phaseIds": [],
+    "processId": "stringstringstringstring",
+    "resourceIds": [],
+    "search": "string",
+    "showEmptyResources": true,
+    "teamAccount": "stringstringstringstring",
+    "user": {}
+  }
+}
+```
+
+---
+
+### v2.activities.files
+
+**Endpoint**: `POST /v2/activities/files`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // Activity ID
+  "1": {
+    "limit": 100,
+    "skip": 0,
+    "search": "string"
+  }
+}
+```
+
+---
+
+### v2.activities.list
+
+With this function, you can get the activities of one workflow and phase (or of one dataset and category) listed by calling the function with workflowId (optional) and phaseId (required) in the Phase object.
+
+**Endpoint**: `POST /v2/activities/list`
+
+**Request Body**:
+```json
+{
+  "0": {
+    "process": "stringstringstringstring",  // Workflow ID
+    "phase": "stringstringstringstring"     // Phase ID
+  },
+  "1": {
+    "sortBy": "updated",
+    "sortOrder": "asc",
+    "filter": {},
+    "search": "string",
+    "limit": 20,
+    "skip": 0,
+    "includeUsers": true,
+    "includeTeams": true,
+    "includeHistory": false
+  }
+}
+```
+
+**Response**: Activities array with metadata object (up to 20 activities by default, sorted by latest update time).
+
+---
+
+### v2.activities.kanban.load
+
+**Endpoint**: `POST /v2/activities/kanban/load`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring"  // Activity ID
+}
+```
+
+---
+
+### v2.activities.kanban.list
+
+**Endpoint**: `POST /v2/activities/kanban/list`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // Workflow ID
+  "1": {
+    "filter": {},
+    "search": "string",
+    "limit": 20,
+    "skip": 0,
+    "phase": "stringstringstringstring",
+    "includeUsers": true,
+    "includeTeams": true
+  }
+}
+```
+
+---
+
+### v2.activities.count.linked
+
+**Endpoint**: `POST /v2/activities/count/linked`
+
+**Request Body**:
+```json
+{
+  "0": ["activityId1", "activityId2"]  // Array of activity IDs
+}
+```
+
+---
+
+### v2.activities.removeFollower
+
+**Endpoint**: `POST /v2/activities/removeFollower`
+
+**Request Body**:
+```json
+{
+  "0": {
+    "activityId": "stringstringstringstring",
+    "userId": "stringstringstringstring"
+  }
+}
+```
+
+---
+
+### v2.activities.updatePriority
+
+Update one or many priority fields in a phase. Ex: change position for activity in Kanban view. Function only used when change position for an activity in same phase.
+
+**Endpoint**: `POST /v2/activities/updatePriority`
+
+**Request Body**:
+```json
+{
+  "0": {
+    "activityId": "stringstringstringstring",
+    "priority": 0
+  }
+}
+```
+
+---
+
+### v2.activities.evaluate
+
+Dryrun Function Field function. Evaluation of Function Field function on a given activity and field without saving the result, only returning it.
+
+**Endpoint**: `POST /v2/activities/evaluate`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // activityId
+  "1": "stringstringstringstring",  // fieldId
+  "2": "string",                    // code
+  "3": {}                           // FunctionDependency
+}
+```
+
+---
+
+### v2.activities.evaluateDependencies
+
+Get dependency graph to the field.
+
+**Endpoint**: `POST /v2/activities/evaluateDependencies`
+
+**Request Body**:
+```json
+{
+  "0": ["activityId1", "activityId2"],  // activityIds
+  "1": ["fieldId1", "fieldId2"]         // fieldIds
+}
+```
+
+---
+
+### v2.activities.dependentFields
+
+Get dependent fields of the given fieldId.
+
+**Endpoint**: `POST /v2/activities/dependentFields`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // processId
+  "1": "stringstringstringstring"   // fieldId
+}
+```
+
+---
+
+### v2.activities.nameIsUnique
+
+**Endpoint**: `POST /v2/activities/nameIsUnique`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // Process ID
+  "1": "string"                      // Activity name to check
+}
+```
+
+---
+
+## V3 Endpoints
+
+### v3.activity.timeline2
+
+**Endpoint**: `POST /v3/activity/timeline2`
+
+**Request Body**:
+```json
+{
+  "0": {
+    "dateFieldId": "stringstringstringstring",
+    "dates": {},
+    "groupByFieldId": "stringstringstringstring",
+    "phaseIds": [],
+    "processId": "stringstringstringstring",
+    "resourceIds": [],
+    "search": "string",
+    "showEmptyResources": true,
+    "teamAccount": "stringstringstringstring",
+    "user": {}
+  }
+}
+```
+
+---
+
+### v3.activity.count
+
+**Endpoint**: `POST /v3/activity/count`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring"  // processId (Workflow ID)
+}
+```
+
+---
+
+### v3.activity.create
+
+Creates one single activity. For creating multiple activities at a time use v3.activity.createMany.
+
+**Endpoint**: `POST /v3/activity/create`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // workflowId
+  "1": {
+    "name": "string",
+    "fields": {},
+    "fileIds": [],
+    "followerIds": [],
+    "location": {},
+    "teamId": "stringstringstringstring",
+    "phaseId": "stringstringstringstring"
+  },
+  "2": {
+    "teamId": "stringstringstringstring",
+    "fileIds": [],
+    "followerIds": [],
+    "location": {},
+    "discussionId": "stringstringstringstring",
+    "phaseId": "stringstringstringstring",
+    "ignoreRequired": false
+  }
+}
+```
+
+---
+
+### v3.activity.createMany
+
+This function is used to create one or more activities at the same time, all in the same workflow.
+
+**Important Notes**:
+- workflowId and at least one Activity object is required
+- Options object applies to all activities unless overridden in Activity object
+- Recommend using v3.activity.template.create first to get field structure
+- If no predefined Owner Team, must set teamId in Activity or Options object
+
+**Endpoint**: `POST /v3/activity/createMany`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // workflowId
+  "1": [
+    {
+      "name": "Activity 1",
+      "fields": {
+        "fieldId1": "value1"
+      },
+      "phaseId": "stringstringstringstring"
+    }
+  ],
+  "2": {
+    "teamId": "stringstringstringstring",
+    "fileIds": [],
+    "followerIds": [],
+    "location": {},
+    "discussionId": "stringstringstringstring",
+    "phaseId": "stringstringstringstring",
+    "returnDocument": true,
+    "ignoreRequired": false
+  }
+}
+```
+
+---
+
+### v3.activity.updateMany
+
+Update one or more activities.
+
+**Important Notes**:
+- Provide array of objects with at least `_id` of activity to update
+- Options object applies to all unless overridden in Activity object
+- Fields/files/followers left unchanged unless specified
+- Adding `fieldId: null` removes old value
+- Adding `"*": null` to files/followers removes all old values
+- Adding `fileId: true` or `userId: true` sets new value
+
+**Endpoint**: `POST /v3/activity/updateMany`
+
+**Request Body**:
+```json
+{
+  "0": [
+    {
+      "_id": "stringstringstringstring",
+      "name": "New Name",
+      "fields": {
+        "fieldId1": "newValue",
+        "fieldId2": null  // Removes value
+      }
+    }
+  ],
+  "1": {
+    "fields": {},
+    "files": {
+      "*": null,  // Remove all files
+      "fileId1": true  // Add this file
+    },
+    "followers": {},
+    "location": {},
+    "discussionId": "stringstringstringstring",
+    "teamId": "stringstringstringstring",
+    "phaseId": "stringstringstringstring",
+    "returnDocument": true,
+    "ignoreRequired": false
+  }
+}
+```
+
+---
+
+### v3.activity.evaluateMany
+
+Dryrun on multiple function fields. Evaluation of Function Field functions on a given activity and field without saving the result, only returning it.
+
+**Endpoint**: `POST /v3/activity/evaluateMany`
+
+**Request Body**:
+```json
+{
+  "0": {
+    "processId": "stringstringstringstring",
+    "phaseId": "stringstringstringstring",
+    "_id": "stringstringstringstring",
+    "name": "string",
+    "fields": {}
+  }
+}
+```
+
+---
+
+### v3.activity.permissions
+
+Will return the permissions of the user in the specified workspace. As an admin you can check the permissions of other users in your workspace.
+
+**Endpoint**: `POST /v3/activity/permissions`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // userId
+  "1": "stringstringstringstring",  // workspaceId
+  "2": {
+    "details": true,
+    "items": {}
+  }
+}
+```
+
+---
+
+### v3.activity.template.create
+
+The successful response from calling this endpoint will give you a template with information for making other API calls related to activities. For example, if you want to create activities, you would want to know the fieldIds for the fields you want to add data to.
+
+**Activity Field Subtypes**:
+- `text` - String (max 2048 chars)
+- `textpredefinedoptions` - Drop-down with options in field's data array
+- `textarea` - String (max 32768 chars)
+- `numeric` - Numeric value
+- `numericunit` - Numeric value with unit string
+- `date`, `time`, `datetime` - Timestamp (integer) in milliseconds since 1970-01-01 UTC
+- `daterange`, `timerange`, `datetimerange` - Object with "start" and "end" timestamps
+- `country` - Two-letter (alpha-2) ISO 3166 country code
+- `activitylink` - Allowed links listed as workflowId(s) in field's data array
+- `users` - One 24-character userId as string
+- `teams` - One 24-character teamId as string
+
+**Endpoint**: `POST /v3/activity/template/create`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // workflowId
+  "1": "stringstringstringstring"   // phaseId
+}
+```
+
+**Response**: Template object with field definitions, types, and IDs.
+
+---
+
+### v3.activity.linkedFrom.overview
+
+Loads given amount of linked activities.
+
+**Endpoint**: `POST /v3/activity/linkedFrom/overview`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // Fetch activities linked to this activityId
+  "1": {
+    "activityLimit": 5000,
+    "includeEmptyWorkflows": false,
+    "phaseIds": []
+  }
+}
+```
+
+---
+
+### v3.activity.linkedFrom.search
+
+Searches linked activities.
+
+**Endpoint**: `POST /v3/activity/linkedFrom/search`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // Activity ID to search links for
+  "1": "string",                    // Search string (matches activity name)
+  "2": {
+    "activityLimit": 250
+  }
+}
+```
+
+---
+
+### v3.activity.linkedFrom.next
+
+Loads linked activities after specified activityId.
+
+**Endpoint**: `POST /v3/activity/linkedFrom/next`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // Fetch activities linked to this activityId
+  "1": "stringstringstringstring",  // Load activities after this activityId
+  "2": {
+    "activityLimit": 250
+  }
+}
+```
+
+---
+
+### v3.activity.linkedFrom.refresh
+
+Loads specified linked activities in a specified phase.
+
+**Endpoint**: `POST /v3/activity/linkedFrom/refresh`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // Fetch activities linked to this activityId
+  "1": "stringstringstringstring",  // Linked phaseId to load from
+  "2": {
+    "activityIds": [],
+    "searchString": "string"
+  }
+}
+```
+
+---
+
+### v3.activity.removed.overview
+
+Lists activities from activityRemoved collection.
+
+**Endpoint**: `POST /v3/activity/removed/overview`
+
+**Request Body**:
+```json
+{
+  "0": ["processId1", "processId2"],  // Array of workflow IDs
+  "1": {
+    "limit": 0,
+    "search": "string"
+  }
+}
+```
+
+---
+
+### v3.activity.removed.more
+
+Lists activities from activityRemoved collection.
+
+**Endpoint**: `POST /v3/activity/removed/more`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // phaseId
+  "1": {
+    "limit": 0,
+    "skip": 0,
+    "search": "string"
+  }
+}
+```
+
+---
+
+### v3.activity.removed.recover
+
+Recover activities from activityRemoved collection.
+
+**Endpoint**: `POST /v3/activity/removed/recover`
+
+**Request Body**:
+```json
+{
+  "0": ["activityId1", "activityId2"]  // Array of activity IDs to recover
+}
+```
+
+---
+
+### v3.activity.import
+
+**Endpoint**: `POST /v3/activity/import`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // fileId
+  "1": {
+    "deleteFile": true
+  }
+}
+```
+
+---
+
+### v3.activity.list
+
+**Endpoint**: `POST /v3/activity/list`
+
+**Request Body**:
+```json
+{
+  "0": {
+    "processId": "stringstringstringstring",
+    "phaseId": "stringstringstringstring"
+  },
+  "1": {
+    "sortBy": "updated",
+    "sortOrder": "asc",
+    "limit": 20,
+    "page": 0,
+    "skip": 0,
+    "includeUsers": true,
+    "includeTeams": true,
+    "includeDates": false,
+    "includeStats": false,
+    "includeActivityLinks": true,
+    "includeHistory": false,
+    "filters": null,
+    "filter": null,
+    "search": "string",
+    "returnFlat": false,
+    "readPreference": "primary",
+    "useIndexedData": true
+  }
+}
+```
+
+---
+
+### v3.activity.events
+
+**Endpoint**: `POST /v3/activity/events`
+
+**Request Body**:
+```json
+{
+  "0": 0,  // Start Date as iso date string or timestamp
+  "1": 0,  // End Date as iso date string or timestamp
+  "2": {
+    "filter": {},
+    "fieldIds": [],
+    "workflowIds": [],
+    "workspaceIds": [],
+    "activityIds": [],
+    "unassigned": true
+  }
+}
+```
+
+---
+
+### v3.activity.timeline
+
+Returns activity events for full-calendar timeline from specified time period and grouped by a field. Allows activity filtering.
+
+**Endpoint**: `POST /v3/activity/timeline`
+
+**Request Body**:
+```json
+{
+  "0": 0,  // Start Date as iso date string or timestamp
+  "1": 0,  // End Date as iso date string or timestamp
+  "2": {
+    "filter": {},
+    "groupBy": {},
+    "resourceIds": [],
+    "showEmptyResources": true,
+    "fieldIds": [],
+    "activityIds": []
+  }
+}
+```
+
+---
+
+### v3.activity.kanban.load
+
+**Endpoint**: `POST /v3/activity/kanban/load`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring"  // Activity ID
+}
+```
+
+---
+
+### v3.activity.kanban.list
+
+**Endpoint**: `POST /v3/activity/kanban/list`
+
+**Request Body**:
+```json
+{
+  "0": "stringstringstringstring",  // workflowId
+  "1": {
+    "filter": {},
+    "search": "string",
+    "limit": 20,
+    "page": 1,
+    "skip": 1,
+    "phase": "stringstringstringstring",
+    "includeUsers": true,
+    "includeTeams": true
+  }
+}
+```
+
+---
+
+## Common Response Format
+
+Most endpoints return responses in this format:
+
+```json
+{
+  "code": 0,
+  "msg": "string",
+  "details": {},
+  "debug": null
+}
+```
+
+- `code: 0` indicates success
+- `code: 403` indicates error/permission denied
+- `details` contains the actual response data
+- `debug` may contain debugging information