Actions
SessionId
Filter by parent action plan (omit to return all actions regardless of plan)
64f8a0e2d5b7c9a1e3f4a5b6When true, returns only standalone actions (no parent plan). Takes precedence over planId.
falseFilter by area/hierarchy (matches any entry in the action's hierarchyIds)
64f8a0e2d5b7c9a1e3f4a5b6Filter by assignee (matches any entry in the assignees list)
64f8a0e2d5b7c9a1e3f4a5b6Status filter
Focus type filter (matches any focusItems entry)
Action type filter
Free-text search on action title and description (case-insensitive contains)
Actions returned (empty list when none match the filters)
Complete action payload returned by the API
Unique action identifier
507f1f77bcf86cd799439011Company that owns this action
507f1f77bcf86cd799439010Parent action plan identifier. Null when the action is standalone.
507f1f77bcf86cd799439013Areas/hierarchies this action targets. Empty means company-wide scope.
64f8a0e2d5b7c9a1e3f4a5b6Groups this action targets.
64f8a0e2d5b7c9a1e3f4a5b6Scope of the action. MANAGER = individual manager action; COMPANY = cross-team action initiated by an admin.
MANAGERPossible values: How the action was originated. MANUAL = created by the user; SUGGESTION = proposed by a company action; AI = generated by the AI assistant.
MANUALPossible values: Visibility scope — PUBLIC means readable by any company manager; PRIVATE restricts to assignees/creator.
PRIVATEPossible values: Aggregate lifecycle status (computed from all assignee states).
IN_PROGRESSPossible values: Percentage of assignees who have individually reached COMPLETED status (0–100). Computed on-the-fly from assigneeStatuses; never stored.
50Target completion date
2025-06-30T23:59:59.000ZTimestamp when the first assignee moved to IN_PROGRESS
Timestamp when all assignees reached a terminal status
User who created this action
507f1f77bcf86cd799439012Creation timestamp
Last modification timestamp
Actions returned (empty list when none match the filters)
SessionId
Request payload for creating a new action
Parent action plan this action belongs to. Omit to create a standalone action not attached to any plan.
507f1f77bcf86cd799439013Areas/hierarchies this action targets. Empty or omitted means company-wide scope.
64f8a0e2d5b7c9a1e3f4a5b6Groups this action targets. Optional.
64f8a0e2d5b7c9a1e3f4a5b6Responsible manager IDs. For MANAGER actions, defaults to the authenticated user when omitted. For COMPANY actions, provide the list of co-responsible managers.
64f8a0e2d5b7c9a1e3f4a5b6Expected completion date. Must be in the future.
2025-06-30T23:59:59.000ZScope of the action. Use MANAGER for individual manager actions, COMPANY for cross-team initiatives.
MANAGERPossible values: How the action was originated. Defaults to MANUAL when omitted.
MANUALPossible values: Template this action was created from. Provide when source=TEMPLATE.
507f1f77bcf86cd799439020Visibility for the action. Defaults to PRIVATE when omitted.
Action created successfully
Complete action payload returned by the API
Unique action identifier
507f1f77bcf86cd799439011Company that owns this action
507f1f77bcf86cd799439010Parent action plan identifier. Null when the action is standalone.
507f1f77bcf86cd799439013Areas/hierarchies this action targets. Empty means company-wide scope.
64f8a0e2d5b7c9a1e3f4a5b6Groups this action targets.
64f8a0e2d5b7c9a1e3f4a5b6Scope of the action. MANAGER = individual manager action; COMPANY = cross-team action initiated by an admin.
MANAGERPossible values: How the action was originated. MANUAL = created by the user; SUGGESTION = proposed by a company action; AI = generated by the AI assistant.
MANUALPossible values: Visibility scope — PUBLIC means readable by any company manager; PRIVATE restricts to assignees/creator.
PRIVATEPossible values: Aggregate lifecycle status (computed from all assignee states).
IN_PROGRESSPossible values: Percentage of assignees who have individually reached COMPLETED status (0–100). Computed on-the-fly from assigneeStatuses; never stored.
50Target completion date
2025-06-30T23:59:59.000ZTimestamp when the first assignee moved to IN_PROGRESS
Timestamp when all assignees reached a terminal status
User who created this action
507f1f77bcf86cd799439012Creation timestamp
Last modification timestamp
Validation failed: missing required fields, empty focusItems, empty assignees, or invalid actionType
SessionId
Action identifier
64f8a0e2d5b7c9a1e3f4a5b6Request payload to apply a lifecycle transition to an action
Target lifecycle status. Only the transitions described above are allowed.
IN_PROGRESSPossible values: Status changed successfully
Complete action payload returned by the API
Unique action identifier
507f1f77bcf86cd799439011Company that owns this action
507f1f77bcf86cd799439010Parent action plan identifier. Null when the action is standalone.
507f1f77bcf86cd799439013Areas/hierarchies this action targets. Empty means company-wide scope.
64f8a0e2d5b7c9a1e3f4a5b6Groups this action targets.
64f8a0e2d5b7c9a1e3f4a5b6Scope of the action. MANAGER = individual manager action; COMPANY = cross-team action initiated by an admin.
MANAGERPossible values: How the action was originated. MANUAL = created by the user; SUGGESTION = proposed by a company action; AI = generated by the AI assistant.
MANUALPossible values: Visibility scope — PUBLIC means readable by any company manager; PRIVATE restricts to assignees/creator.
PRIVATEPossible values: Aggregate lifecycle status (computed from all assignee states).
IN_PROGRESSPossible values: Percentage of assignees who have individually reached COMPLETED status (0–100). Computed on-the-fly from assigneeStatuses; never stored.
50Target completion date
2025-06-30T23:59:59.000ZTimestamp when the first assignee moved to IN_PROGRESS
Timestamp when all assignees reached a terminal status
User who created this action
507f1f77bcf86cd799439012Creation timestamp
Last modification timestamp
Transition not allowed from the current status, or status value is invalid
Action not found in this company
SessionId
Action identifier
64f8a0e2d5b7c9a1e3f4a5b6Zero-based start index (default 0)
0Exclusive end index (default 20)
20Notes page returned (empty result when none match)
Action not found in this company
SessionId
Action identifier
64f8a0e2d5b7c9a1e3f4a5b6Request payload to append a note to the action execution log
Note body text describing progress, blockers or context updates
El feedback de la retro mejoró notablemente tras introducir los reconocimientos entre pares.Who can see this note. PRIVATE = only the author; SHARED = all action participants. Defaults to PRIVATE.
PRIVATEPossible values: Note created and returned
A single note appended to the action execution log
Note identifier (unique within the parent action)
507f1f77bcf86cd799439020User who wrote the note
507f1f77bcf86cd799439015Note body text
Feedback de la retro mejoró tras introducir los reconocimientos entre pares.Who can see this note. PRIVATE = only the author; SHARED = all action participants.
SHAREDPossible values: Creation timestamp
Content is blank or action not found
Action not found in this company
SessionId
Action identifier
64f8a0e2d5b7c9a1e3f4a5b6Capture triggered (or was already present — idempotent)
No content
Action not found or not in a terminal status
No content
SessionId
Action identifier
64f8a0e2d5b7c9a1e3f4a5b6Export triggered — file will be sent by e-mail
No content
Export triggered — file will be sent by e-mail
No content
SessionId
Optional parameters that narrow the AI action suggestion context
Restrict score analysis to a specific team/hierarchy. When omitted, company-wide data is used.
507f1f77bcf86cd799439012Start of the measurement window (inclusive). When omitted, defaults to 30 days before 'to' (or before now if 'to' is also omitted).
2025-03-01T00:00:00.000ZEnd of the measurement window (inclusive). Defaults to the current date/time when omitted.
2025-05-31T23:59:59.000ZFree-text hint that gives the AI additional context about the current situation. Max 500 characters.
Our team had two people leave last month and morale seems low.BCP-47 language code for the suggestion text. Defaults to 'es' when omitted.
esExample: esSuggestions generated (may be an empty list if no engagement data is available)
AI-generated action suggestion — all fields pre-filled and ready for user review. Can be forwarded directly to POST /v1/company/actions after confirmation.
Short title describing the suggested action
Implementar rituales de reconocimiento semanalesDetailed execution plan: how, when, and why this action addresses the focus indicator
Cada viernes dedicar 10 minutos al inicio del standup a reconocer un logro concreto de un miembro del equipo.Recommended action scope. MANAGER for individual-team actions; COMPANY for cross-team initiatives.
MANAGERPossible values: Suggested target completion date. Map this directly to the dueDate field when creating the action.
2025-09-01T00:00:00.000ZAreas/hierarchies this action is pre-scoped to. Pre-populated from the teamId in the suggestion request; empty for company-wide suggestions.
64f8a0e2d5b7c9a1e3f4a5b6Responsible managers. Empty — must be filled by the user before confirming.
64f8a0e2d5b7c9a1e3f4a5b6Current measured value of the focus indicator at the time the suggestion was generated. Provides context to show the user the baseline the action targets (e.g. 4.3 for a score on a 0–10 scale, or 62 for HI on a 0–100 scale). Null when the measurement was unavailable for the requested period.
Brief explanation of why the model recommends this action, based on the data analysed.
El factor Reconocimiento lleva 3 pulsos consecutivos con valores inferiores a 5, lo que suele correlacionar con mayor rotación.Always AI for suggestions generated by this endpoint.
AIPossible values: Request validation failed
AI service unavailable or returned an unparseable response
SessionId
Comment (idea) identifier
64f8a0e2d5b7c9a1e3f4a5b6Action suggestion generated from the comment
AI-generated action suggestion — all fields pre-filled and ready for user review. Can be forwarded directly to POST /v1/company/actions after confirmation.
Short title describing the suggested action
Implementar rituales de reconocimiento semanalesDetailed execution plan: how, when, and why this action addresses the focus indicator
Cada viernes dedicar 10 minutos al inicio del standup a reconocer un logro concreto de un miembro del equipo.Recommended action scope. MANAGER for individual-team actions; COMPANY for cross-team initiatives.
MANAGERPossible values: Suggested target completion date. Map this directly to the dueDate field when creating the action.
2025-09-01T00:00:00.000ZAreas/hierarchies this action is pre-scoped to. Pre-populated from the teamId in the suggestion request; empty for company-wide suggestions.
64f8a0e2d5b7c9a1e3f4a5b6Responsible managers. Empty — must be filled by the user before confirming.
64f8a0e2d5b7c9a1e3f4a5b6Current measured value of the focus indicator at the time the suggestion was generated. Provides context to show the user the baseline the action targets (e.g. 4.3 for a score on a 0–10 scale, or 62 for HI on a 0–100 scale). Null when the measurement was unavailable for the requested period.
Brief explanation of why the model recommends this action, based on the data analysed.
El factor Reconocimiento lleva 3 pulsos consecutivos con valores inferiores a 5, lo que suele correlacionar con mayor rotación.Always AI for suggestions generated by this endpoint.
AIPossible values: Comment not found in this company, or comment has no text
AI service unavailable or returned an unparseable response
SessionId
Action identifier
64f8a0e2d5b7c9a1e3f4a5b6Action found
Complete action payload returned by the API
Unique action identifier
507f1f77bcf86cd799439011Company that owns this action
507f1f77bcf86cd799439010Parent action plan identifier. Null when the action is standalone.
507f1f77bcf86cd799439013Areas/hierarchies this action targets. Empty means company-wide scope.
64f8a0e2d5b7c9a1e3f4a5b6Groups this action targets.
64f8a0e2d5b7c9a1e3f4a5b6Scope of the action. MANAGER = individual manager action; COMPANY = cross-team action initiated by an admin.
MANAGERPossible values: How the action was originated. MANUAL = created by the user; SUGGESTION = proposed by a company action; AI = generated by the AI assistant.
MANUALPossible values: Visibility scope — PUBLIC means readable by any company manager; PRIVATE restricts to assignees/creator.
PRIVATEPossible values: Aggregate lifecycle status (computed from all assignee states).
IN_PROGRESSPossible values: Percentage of assignees who have individually reached COMPLETED status (0–100). Computed on-the-fly from assigneeStatuses; never stored.
50Target completion date
2025-06-30T23:59:59.000ZTimestamp when the first assignee moved to IN_PROGRESS
Timestamp when all assignees reached a terminal status
User who created this action
507f1f77bcf86cd799439012Creation timestamp
Last modification timestamp
Action not found in this company
SessionId
Action identifier
64f8a0e2d5b7c9a1e3f4a5b6Action deleted
Caller is not the creator or an admin
Action not found in this company
No content
SessionId
Action identifier
64f8a0e2d5b7c9a1e3f4a5b6Partial update payload for an existing action. Only non-null fields are applied.
Extended due date. Must not be earlier than the action creation date.
2025-09-30T23:59:59.000ZUpdated action origin.
SUGGESTIONPossible values: Replaces the full assignees list when non-null. Use this to add or remove co-responsible managers. Must be non-empty if provided.
64f8a0e2d5b7c9a1e3f4a5b6Moves the action to the specified plan when non-null. The plan must belong to the same company. Omit (or send null) to leave the current plan unchanged.
507f1f77bcf86cd799439013New visibility. Null means no change.
Action updated successfully
Complete action payload returned by the API
Unique action identifier
507f1f77bcf86cd799439011Company that owns this action
507f1f77bcf86cd799439010Parent action plan identifier. Null when the action is standalone.
507f1f77bcf86cd799439013Areas/hierarchies this action targets. Empty means company-wide scope.
64f8a0e2d5b7c9a1e3f4a5b6Groups this action targets.
64f8a0e2d5b7c9a1e3f4a5b6Scope of the action. MANAGER = individual manager action; COMPANY = cross-team action initiated by an admin.
MANAGERPossible values: How the action was originated. MANUAL = created by the user; SUGGESTION = proposed by a company action; AI = generated by the AI assistant.
MANUALPossible values: Visibility scope — PUBLIC means readable by any company manager; PRIVATE restricts to assignees/creator.
PRIVATEPossible values: Aggregate lifecycle status (computed from all assignee states).
IN_PROGRESSPossible values: Percentage of assignees who have individually reached COMPLETED status (0–100). Computed on-the-fly from assigneeStatuses; never stored.
50Target completion date
2025-06-30T23:59:59.000ZTimestamp when the first assignee moved to IN_PROGRESS
Timestamp when all assignees reached a terminal status
User who created this action
507f1f77bcf86cd799439012Creation timestamp
Last modification timestamp
Invalid field values, dueDate before creation date, or action is already closed
Action not found in this company
SessionId
Action identifier
64f8a0e2d5b7c9a1e3f4a5b6Admin only: request a specific manager's scoped impact snapshot instead of the global one
64f8a0e2d5b7c9a1e3f4a5b6Impact document found and returned
Impact measurement for a closed action, showing how the focus indicators evolved before, at and after the action was executed
Impact document identifier
507f1f77bcf86cd799439011Related action identifier
507f1f77bcf86cd799439012Manager this snapshot is scoped to. Null for the global company-wide snapshot.
507f1f77bcf86cd799439013Terminal state that triggered impact capture
COMPLETEDPossible values: When the action reached its terminal state
When the measurement window closes — no more re-evaluations after this date (closedAt + windowDays)
Number of periodic re-evaluations performed so far
3Timestamp of the most recent periodic re-evaluation
No impact document for this action
Last updated