> For the complete documentation index, see [llms.txt](https://api-docs.myhappyforce.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.myhappyforce.com/docs/api-reference/action-templates.md).

# Action Templates

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

## Browse the global template catalog

> 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.

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[{"name":"Action Templates","description":"Browse the global catalog of reusable action templates derived from positive-impact actions across all companies."}],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"PaginableGenericResultListActionTemplateDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ActionTemplateDTO"}}}},"ActionTemplateDTO":{"type":"object","description":"Global reusable action template — auto-generated from positive-impact actions","properties":{"id":{"type":"string","description":"Unique template identifier"},"title":{"$ref":"#/components/schemas/MultiLanguage","description":"Template title (multilingual)"},"description":{"$ref":"#/components/schemas/MultiLanguage","description":"Detailed description of the action to carry out (multilingual)"},"focusType":{"type":"string","description":"Focus indicator type (SCORE, HI or ENPS). Always globally portable.","enum":["SCORE","FACTOR","QUESTION","ENPS","HI"]},"focusId":{"type":"string","description":"Global focus indicator id (score type, HI or eNPS identifier)."},"actionType":{"type":"string","description":"Suggested action scope (MANAGER or COMPANY). Null when either scope applies.","enum":["MANAGER","COMPANY"]},"suggestedDueDays":{"type":"integer","format":"int32","description":"Suggested days to complete the action. 0 means not specified."},"tags":{"type":"array","description":"Free-form tags for filtering the catalog","items":{"type":"string"}},"sourceActionId":{"type":"string","description":"Source action this template was derived from."},"originCompanyId":{"type":"string","description":"Company that originally generated this template (attribution)."},"createdBy":{"type":"string","description":"User who owned the source action"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}},"paths":{"/api/v1/company/action-templates":{"get":{"tags":["Action Templates"],"summary":"Browse the global template catalog","description":"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.","operationId":"listTemplates","parameters":[{"name":"focusType","in":"query","description":"Filter by focus indicator type (optional)","required":false,"schema":{"type":"string","enum":["SCORE","FACTOR","QUESTION","ENPS","HI"]}},{"name":"from","in":"query","description":"Zero-based start index (default 0)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"to","in":"query","description":"Exclusive end index (default 10, so first page = items 0–9)","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"Paginated template list","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PaginableGenericResultListActionTemplateDTO"}}}}}}}}}
```

## Get a template

> Returns the full template payload.

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[{"name":"Action Templates","description":"Browse the global catalog of reusable action templates derived from positive-impact actions across all companies."}],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"ActionTemplateDTO":{"type":"object","description":"Global reusable action template — auto-generated from positive-impact actions","properties":{"id":{"type":"string","description":"Unique template identifier"},"title":{"$ref":"#/components/schemas/MultiLanguage","description":"Template title (multilingual)"},"description":{"$ref":"#/components/schemas/MultiLanguage","description":"Detailed description of the action to carry out (multilingual)"},"focusType":{"type":"string","description":"Focus indicator type (SCORE, HI or ENPS). Always globally portable.","enum":["SCORE","FACTOR","QUESTION","ENPS","HI"]},"focusId":{"type":"string","description":"Global focus indicator id (score type, HI or eNPS identifier)."},"actionType":{"type":"string","description":"Suggested action scope (MANAGER or COMPANY). Null when either scope applies.","enum":["MANAGER","COMPANY"]},"suggestedDueDays":{"type":"integer","format":"int32","description":"Suggested days to complete the action. 0 means not specified."},"tags":{"type":"array","description":"Free-form tags for filtering the catalog","items":{"type":"string"}},"sourceActionId":{"type":"string","description":"Source action this template was derived from."},"originCompanyId":{"type":"string","description":"Company that originally generated this template (attribution)."},"createdBy":{"type":"string","description":"User who owned the source action"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}},"paths":{"/api/v1/company/action-templates/{templateId}":{"get":{"tags":["Action Templates"],"summary":"Get a template","description":"Returns the full template payload.","operationId":"getTemplate","parameters":[{"name":"templateId","in":"path","description":"Template identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Template found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ActionTemplateDTO"}}}},"404":{"description":"Template not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ActionTemplateDTO"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://api-docs.myhappyforce.com/docs/api-reference/action-templates.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.