Action Templates

Browse the global catalog of reusable action templates derived from positive-impact actions across all companies.

Browse the global template catalog

get

Returns a paginated slice of the global catalog, sorted from newest to oldest. Use the optional focusType filter to narrow results to templates targeting a specific indicator type (SCORE, HI, ENPS). from is the zero-based start index; to is the exclusive end index (page size = to − from, default 10 items). Templates are generated automatically from positive-impact actions.

Authorizations

SessionIdstringRequired

SessionId

Query parameters

focusTypestring · enumOptional

Filter by focus indicator type (optional)

Possible values:

frominteger · int32Optional

Zero-based start index (default 0)

Default: 0

tointeger · int32Optional

Exclusive end index (default 10, so first page = items 0–9)

Default: 10

Responses

200

Paginated template list

*/*

frominteger · int32Optional

tointeger · int64Optional

totalinteger · int64Optional

get/api/v1/company/action-templates

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

200

Paginated template list

{
  "from": 1,
  "to": 1,
  "total": 1,
  "result": [
    {
      "id": "507f1f77bcf86cd799439020",
      "title": {
        "defaultValue": "Happy birthday!",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "description": {
        "defaultValue": "Happy birthday!",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "focusType": "SCORE",
      "focusId": "text",
      "actionType": "MANAGER",
      "suggestedDueDays": 30,
      "tags": [
        "recognition",
        "communication"
      ],
      "sourceActionId": "507f1f77bcf86cd799439011",
      "originCompanyId": "507f1f77bcf86cd799439030",
      "createdBy": "507f1f77bcf86cd799439012",
      "createdAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Get a template

get

Returns the full template payload.

Authorizations

SessionIdstringRequired

SessionId

Path parameters

templateIdstringRequired

Template identifier

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

Template found

*/*

Global reusable action template — auto-generated from positive-impact actions

idstringOptional

Unique template identifier

Example: 507f1f77bcf86cd799439020

focusTypestring · enumOptional

Focus indicator type (SCORE, HI or ENPS). Always globally portable.

Possible values:

focusIdstringOptional

Global focus indicator id (score type, HI or eNPS identifier).

actionTypestring · enumOptional

Suggested action scope (MANAGER or COMPANY). Null when either scope applies.

Possible values:

suggestedDueDaysinteger · int32Optional

Suggested days to complete the action. 0 means not specified.

Example: 30

tagsstring[]Optional

Free-form tags for filtering the catalog

Example: ["recognition","communication"]

sourceActionIdstringOptional

Source action this template was derived from.

Example: 507f1f77bcf86cd799439011

originCompanyIdstringOptional

Company that originally generated this template (attribution).

Example: 507f1f77bcf86cd799439030

createdBystringOptional

User who owned the source action

Example: 507f1f77bcf86cd799439012

createdAtstring · date-timeOptional

Creation timestamp

404

Template not found

*/*

get/api/v1/company/action-templates/{templateId}

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

{
  "id": "507f1f77bcf86cd799439020",
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "description": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "focusType": "SCORE",
  "focusId": "text",
  "actionType": "MANAGER",
  "suggestedDueDays": 30,
  "tags": [
    "recognition",
    "communication"
  ],
  "sourceActionId": "507f1f77bcf86cd799439011",
  "originCompanyId": "507f1f77bcf86cd799439030",
  "createdBy": "507f1f77bcf86cd799439012",
  "createdAt": "2026-01-01T00:00:00.000Z"
}