Action Plans

Create and manage action plans — named containers that group improvement actions under a shared goal. Every action must belong to a plan.

List action plans

get

Returns a paginated slice of action plans, sorted newest-first. Each plan includes its actions — filtered when any filter param is set. With filters: only plans with at least one matching action are returned; each plan's actions[] contains only matching actions; total counts matching plans. Without filters: all plans, all actions. from / to are zero-based offset / exclusive end index.

Authorizations

SessionIdstringRequired

SessionId

Query parameters

frominteger · int32Optional

Zero-based start index (default 0)

Default: 0

tointeger · int32Optional

Exclusive end index (default 10)

Default: 10

statusstring · enumOptional

Filter plans whose actions have this status

Possible values:

focusTypestring · enumOptional

Filter plans whose actions target this focus type

Possible values:

hierarchyIdstringOptional

Filter plans whose actions target this hierarchy

Example: 64f8a0e2d5b7c9a1e3f4a5b6

assigneeIdstringOptional

Filter plans whose actions include this assignee

Example: 64f8a0e2d5b7c9a1e3f4a5b6

actionTypestring · enumOptional

Filter plans whose actions target this action type

Possible values:

qstringOptional

Free-text search on action title and description (case-insensitive contains)

Responses

200

Paginated plan list, each with their (filtered) actions

*/*

frominteger · int32Optional

tointeger · int64Optional

totalinteger · int64Optional

get/api/v1/company/action-plans

GET /api/v1/company/action-plans HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*

200

Paginated plan list, each with their (filtered) actions

{
  "from": 1,
  "to": 1,
  "total": 1,
  "result": [
    {
      "id": "507f1f77bcf86cd799439011",
      "companyId": "507f1f77bcf86cd799439010",
      "title": {
        "defaultValue": "Happy birthday!",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "description": {
        "defaultValue": "Happy birthday!",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "actions": [
        {
          "id": "507f1f77bcf86cd799439011",
          "companyId": "507f1f77bcf86cd799439010",
          "planId": "507f1f77bcf86cd799439013",
          "plan": {
            "id": "507f1f77bcf86cd799439013",
            "title": {
              "defaultValue": "Happy birthday!",
              "langValues": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "valid": true
            },
            "description": {
              "defaultValue": "Happy birthday!",
              "langValues": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "valid": true
            }
          },
          "title": {
            "defaultValue": "Happy birthday!",
            "langValues": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "valid": true
          },
          "description": {
            "defaultValue": "Happy birthday!",
            "langValues": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "valid": true
          },
          "focusItems": [
            {
              "focusType": "SCORE",
              "focusId": "text",
              "targetValue": 1,
              "targetTimestamp": "2026-01-01T00:00:00.000Z"
            }
          ],
          "assigneeStatuses": [
            {
              "assigneeId": "507f1f77bcf86cd799439011",
              "status": "IN_PROGRESS",
              "startedAt": "2026-01-01T00:00:00.000Z",
              "completedAt": "2026-01-01T00:00:00.000Z"
            }
          ],
          "hierarchyIds": [
            "64f8a0e2d5b7c9a1e3f4a5b6"
          ],
          "groupIds": [
            "64f8a0e2d5b7c9a1e3f4a5b6"
          ],
          "characteristics": [
            {
              "characteristicId": "64f8a0e2d5b7c9a1e3f4a5b6",
              "id": "64f8a0e2d5b7c9a1e3f4a5b6",
              "questionType": "DATE",
              "value": true
            }
          ],
          "actionType": "MANAGER",
          "source": "MANUAL",
          "visibility": "PRIVATE",
          "status": "IN_PROGRESS",
          "completionPercent": 50,
          "dueDate": "2025-06-30T23:59:59.000Z",
          "startedAt": "2026-01-01T00:00:00.000Z",
          "completedAt": "2026-01-01T00:00:00.000Z",
          "createdBy": "507f1f77bcf86cd799439012",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z",
          "notes": [
            {
              "id": "507f1f77bcf86cd799439020",
              "authorId": "507f1f77bcf86cd799439015",
              "content": "Feedback de la retro mejoró tras introducir los reconocimientos entre pares.",
              "visibility": "SHARED",
              "createdAt": "2026-01-01T00:00:00.000Z"
            }
          ]
        }
      ],
      "visibility": "PRIVATE",
      "completionPercent": 33,
      "createdBy": "507f1f77bcf86cd799439012",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create a new action plan

post

Creates an empty action plan. Once created, actions can be added by creating them with the plan's ID.

Authorizations

SessionIdstringRequired

SessionId

Body

Request payload for creating a new action plan

visibilitystring · enumOptional

Visibility for the plan. Defaults to PRIVATE when omitted.

Possible values:

Responses

200

Plan created successfully

*/*

Action plan — a named container grouping one or more improvement actions under a shared goal

idstringOptional

Unique plan identifier

Example: 507f1f77bcf86cd799439011

companyIdstringOptional

Company that owns this plan

Example: 507f1f77bcf86cd799439010

visibilitystring · enumOptional

Visibility scope — PUBLIC means readable by any company manager; PRIVATE restricts to the plan creator.

Example: PRIVATEPossible values:

completionPercentinteger · int32Optional

Percentage of actions in this plan that have reached COMPLETED status (0–100). Computed on-the-fly; never stored.

Example: 33

createdBystringOptional

User who created this plan

Example: 507f1f77bcf86cd799439012

createdAtstring · date-timeOptional

Creation timestamp

updatedAtstring · date-timeOptional

Last modification timestamp

400

Validation failed: missing title or description

*/*

post/api/v1/company/action-plans

POST /api/v1/company/action-plans HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 237

{
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "description": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "visibility": "PUBLIC"
}

{
  "id": "507f1f77bcf86cd799439011",
  "companyId": "507f1f77bcf86cd799439010",
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "description": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "actions": [
    {
      "id": "507f1f77bcf86cd799439011",
      "companyId": "507f1f77bcf86cd799439010",
      "planId": "507f1f77bcf86cd799439013",
      "plan": {
        "id": "507f1f77bcf86cd799439013",
        "title": {
          "defaultValue": "Happy birthday!",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        },
        "description": {
          "defaultValue": "Happy birthday!",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        }
      },
      "title": {
        "defaultValue": "Happy birthday!",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "description": {
        "defaultValue": "Happy birthday!",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "focusItems": [
        {
          "focusType": "SCORE",
          "focusId": "text",
          "targetValue": 1,
          "targetTimestamp": "2026-01-01T00:00:00.000Z"
        }
      ],
      "assigneeStatuses": [
        {
          "assigneeId": "507f1f77bcf86cd799439011",
          "status": "IN_PROGRESS",
          "startedAt": "2026-01-01T00:00:00.000Z",
          "completedAt": "2026-01-01T00:00:00.000Z"
        }
      ],
      "hierarchyIds": [
        "64f8a0e2d5b7c9a1e3f4a5b6"
      ],
      "groupIds": [
        "64f8a0e2d5b7c9a1e3f4a5b6"
      ],
      "characteristics": [
        {
          "characteristicId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "id": "64f8a0e2d5b7c9a1e3f4a5b6",
          "questionType": "DATE",
          "value": true
        }
      ],
      "actionType": "MANAGER",
      "source": "MANUAL",
      "visibility": "PRIVATE",
      "status": "IN_PROGRESS",
      "completionPercent": 50,
      "dueDate": "2025-06-30T23:59:59.000Z",
      "startedAt": "2026-01-01T00:00:00.000Z",
      "completedAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "507f1f77bcf86cd799439012",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "notes": [
        {
          "id": "507f1f77bcf86cd799439020",
          "authorId": "507f1f77bcf86cd799439015",
          "content": "Feedback de la retro mejoró tras introducir los reconocimientos entre pares.",
          "visibility": "SHARED",
          "createdAt": "2026-01-01T00:00:00.000Z"
        }
      ]
    }
  ],
  "visibility": "PRIVATE",
  "completionPercent": 33,
  "createdBy": "507f1f77bcf86cd799439012",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Export action plan to Excel

post

Triggers an asynchronous Excel export of this action plan. The workbook contains a summary sheet followed by one sheet per action. The file will be delivered to your e-mail address as a time-limited download link. The response is empty — the file arrives via e-mail within seconds.

Authorizations

SessionIdstringRequired

SessionId

Path parameters

planIdstringRequired

Plan identifier

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

Export triggered — file will be sent by e-mail

No content

post/api/v1/company/action-plans/{planId}/excel

POST /api/v1/company/action-plans/{planId}/excel HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*

200

Export triggered — file will be sent by e-mail

No content

Get action plan details

get

Returns the full action plan with its actions.

Authorizations

SessionIdstringRequired

SessionId

Path parameters

planIdstringRequired

Plan identifier

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

Plan found

*/*

Action plan — a named container grouping one or more improvement actions under a shared goal

idstringOptional

Unique plan identifier

Example: 507f1f77bcf86cd799439011

companyIdstringOptional

Company that owns this plan

Example: 507f1f77bcf86cd799439010

visibilitystring · enumOptional

Visibility scope — PUBLIC means readable by any company manager; PRIVATE restricts to the plan creator.

Example: PRIVATEPossible values:

completionPercentinteger · int32Optional

Percentage of actions in this plan that have reached COMPLETED status (0–100). Computed on-the-fly; never stored.

Example: 33

createdBystringOptional

User who created this plan

Example: 507f1f77bcf86cd799439012

createdAtstring · date-timeOptional

Creation timestamp

updatedAtstring · date-timeOptional

Last modification timestamp

404

Plan not found in this company

*/*

get/api/v1/company/action-plans/{planId}

GET /api/v1/company/action-plans/{planId} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*

{
  "id": "507f1f77bcf86cd799439011",
  "companyId": "507f1f77bcf86cd799439010",
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "description": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "actions": [
    {
      "id": "507f1f77bcf86cd799439011",
      "companyId": "507f1f77bcf86cd799439010",
      "planId": "507f1f77bcf86cd799439013",
      "plan": {
        "id": "507f1f77bcf86cd799439013",
        "title": {
          "defaultValue": "Happy birthday!",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        },
        "description": {
          "defaultValue": "Happy birthday!",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        }
      },
      "title": {
        "defaultValue": "Happy birthday!",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "description": {
        "defaultValue": "Happy birthday!",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "focusItems": [
        {
          "focusType": "SCORE",
          "focusId": "text",
          "targetValue": 1,
          "targetTimestamp": "2026-01-01T00:00:00.000Z"
        }
      ],
      "assigneeStatuses": [
        {
          "assigneeId": "507f1f77bcf86cd799439011",
          "status": "IN_PROGRESS",
          "startedAt": "2026-01-01T00:00:00.000Z",
          "completedAt": "2026-01-01T00:00:00.000Z"
        }
      ],
      "hierarchyIds": [
        "64f8a0e2d5b7c9a1e3f4a5b6"
      ],
      "groupIds": [
        "64f8a0e2d5b7c9a1e3f4a5b6"
      ],
      "characteristics": [
        {
          "characteristicId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "id": "64f8a0e2d5b7c9a1e3f4a5b6",
          "questionType": "DATE",
          "value": true
        }
      ],
      "actionType": "MANAGER",
      "source": "MANUAL",
      "visibility": "PRIVATE",
      "status": "IN_PROGRESS",
      "completionPercent": 50,
      "dueDate": "2025-06-30T23:59:59.000Z",
      "startedAt": "2026-01-01T00:00:00.000Z",
      "completedAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "507f1f77bcf86cd799439012",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "notes": [
        {
          "id": "507f1f77bcf86cd799439020",
          "authorId": "507f1f77bcf86cd799439015",
          "content": "Feedback de la retro mejoró tras introducir los reconocimientos entre pares.",
          "visibility": "SHARED",
          "createdAt": "2026-01-01T00:00:00.000Z"
        }
      ]
    }
  ],
  "visibility": "PRIVATE",
  "completionPercent": 33,
  "createdBy": "507f1f77bcf86cd799439012",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Delete an action plan

delete

Permanently removes an action plan and all of its actions (cascade delete). Only the plan creator or an admin can delete; legacy plans without a recorded creator are deletable by any authorised caller. Returns 204 on success, 403 when the caller is not allowed, 404 when not found.

Authorizations

SessionIdstringRequired

SessionId

Path parameters

planIdstringRequired

Plan identifier

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

204

Plan and all its actions deleted

No content

403

Caller is not the creator or an admin

404

Plan not found in this company

delete/api/v1/company/action-plans/{planId}

DELETE /api/v1/company/action-plans/{planId} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*

No content

Update action plan

patch

Applies a partial update to an action plan. Only non-null fields are updated.

Authorizations

SessionIdstringRequired

SessionId

Path parameters

planIdstringRequired

Plan identifier

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Body

Request payload for updating an action plan. Only non-null fields are applied.

visibilitystring · enumOptional

New visibility. Null means no change.

Possible values:

Responses

200

Plan updated successfully

*/*

Action plan — a named container grouping one or more improvement actions under a shared goal

idstringOptional

Unique plan identifier

Example: 507f1f77bcf86cd799439011

companyIdstringOptional

Company that owns this plan

Example: 507f1f77bcf86cd799439010

visibilitystring · enumOptional

Visibility scope — PUBLIC means readable by any company manager; PRIVATE restricts to the plan creator.

Example: PRIVATEPossible values:

completionPercentinteger · int32Optional

Percentage of actions in this plan that have reached COMPLETED status (0–100). Computed on-the-fly; never stored.

Example: 33

createdBystringOptional

User who created this plan

Example: 507f1f77bcf86cd799439012

createdAtstring · date-timeOptional

Creation timestamp

updatedAtstring · date-timeOptional

Last modification timestamp

400

No updatable fields provided, or plan not found

*/*

404

Plan not found in this company

*/*

patch/api/v1/company/action-plans/{planId}

PATCH /api/v1/company/action-plans/{planId} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 237

{
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "description": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "visibility": "PUBLIC"
}

{
  "id": "507f1f77bcf86cd799439011",
  "companyId": "507f1f77bcf86cd799439010",
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "description": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "actions": [
    {
      "id": "507f1f77bcf86cd799439011",
      "companyId": "507f1f77bcf86cd799439010",
      "planId": "507f1f77bcf86cd799439013",
      "plan": {
        "id": "507f1f77bcf86cd799439013",
        "title": {
          "defaultValue": "Happy birthday!",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        },
        "description": {
          "defaultValue": "Happy birthday!",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        }
      },
      "title": {
        "defaultValue": "Happy birthday!",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "description": {
        "defaultValue": "Happy birthday!",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "focusItems": [
        {
          "focusType": "SCORE",
          "focusId": "text",
          "targetValue": 1,
          "targetTimestamp": "2026-01-01T00:00:00.000Z"
        }
      ],
      "assigneeStatuses": [
        {
          "assigneeId": "507f1f77bcf86cd799439011",
          "status": "IN_PROGRESS",
          "startedAt": "2026-01-01T00:00:00.000Z",
          "completedAt": "2026-01-01T00:00:00.000Z"
        }
      ],
      "hierarchyIds": [
        "64f8a0e2d5b7c9a1e3f4a5b6"
      ],
      "groupIds": [
        "64f8a0e2d5b7c9a1e3f4a5b6"
      ],
      "characteristics": [
        {
          "characteristicId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "id": "64f8a0e2d5b7c9a1e3f4a5b6",
          "questionType": "DATE",
          "value": true
        }
      ],
      "actionType": "MANAGER",
      "source": "MANUAL",
      "visibility": "PRIVATE",
      "status": "IN_PROGRESS",
      "completionPercent": 50,
      "dueDate": "2025-06-30T23:59:59.000Z",
      "startedAt": "2026-01-01T00:00:00.000Z",
      "completedAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "507f1f77bcf86cd799439012",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "notes": [
        {
          "id": "507f1f77bcf86cd799439020",
          "authorId": "507f1f77bcf86cd799439015",
          "content": "Feedback de la retro mejoró tras introducir los reconocimientos entre pares.",
          "visibility": "SHARED",
          "createdAt": "2026-01-01T00:00:00.000Z"
        }
      ]
    }
  ],
  "visibility": "PRIVATE",
  "completionPercent": 33,
  "createdBy": "507f1f77bcf86cd799439012",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}