List templates

Return a paginated list of notification templates.

POST /template/list

List templates

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/template/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "p": 1,
  "limit": 20,
  "orderby": "updated_at",
  "asc": false,
  "is_my_team": false
}
'

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 47,
    "has_next_page": true,
    "items": [
      {
        "account_id": 10023,
        "team_id": 0,
        "template_id": "6605a1b2c3d4e5f6a7b8c9d0",
        "template_name": "Prod incident default",
        "description": "Default template for production incidents.",
        "email": "Incident {{ .IncidentName }} on {{ .Severity }}",
        "sms": "[Flashduty] {{ .IncidentName }} — {{ .Severity }}",
        "voice": "",
        "dingtalk": "",
        "wecom": "",
        "feishu": "",
        "feishu_app": "",
        "dingtalk_app": "",
        "wecom_app": "",
        "slack_app": "",
        "teams_app": "",
        "telegram": "",
        "slack": "",
        "zoom": "",
        "status": "enabled",
        "creator_id": 80011,
        "updated_by": 80011,
        "created_at": 1712700000,
        "updated_at": 1712702400
      }
    ]
  }
}

Restrictions

Aspect	Value
Rate limits	1,000 requests/minute; 50 requests/second per account
Permissions	Templates Read (on-call) or Templates Manage (on-call)

Usage

• Pagination defaults to page 1 with 20 rows. The response’s has_next_page tells you whether another page exists without needing a separate count request.
• When is_my_team is true, team_ids is ignored.

Authorizations

app_key · string · query · required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Paginated list filters. Defaults: p=1, limit=20. Max limit=100.

p · integer · default: 1

Page number, starting at 1.

Required range: x >= 1

Example:

1

limit · integer · default: 20

Page size. Capped at 100.

Required range: 1 <= x <= 100

Example:

20

orderby · enum<string>

Sort field.

Available options: created_at, updated_at

asc · boolean · default: false

Ascending sort order.

is_my_team · boolean · default: false

When true, only return templates scoped to teams the caller belongs to.

team_ids · integer<int64>[]

Filter by specific team IDs.

creator_id · integer<int64> | null

Filter by creator member ID.

query · string

Regex or substring match on template_name.

Response

200

application/json

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id · string · required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · required

Paginated template list.

Show child attributes