Export

Description

Export a case template to a transferable JSON file. The result can be loaded with the import endpoint to recreate the template on the same tenant or on another tenant.

Request

HTTP Method: GET

Path Parameter Description
id The ID of the case template to export.
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/case_templates/<<id>>/export \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON object representing the case template in exported form.

Field description

Parameter Description
schema_version Version of the case template export schema.
exported_at ISO 8601 timestamp representing when the template was exported.
templates An array of exported case templates.

Each entry in templates contains:

Parameter Description
name The case template name.
emoji The emoji associated with the case template.
options An object describing the case template configuration. See Options fields below.
input_values An array of case input values defined on the template, referenced by field slug.
field_definitions An array describing the case input fields referenced by the template, so the template can be imported into another team.

Options fields

Parameter Description
case_name Optional The case name template. May contain field mentions written as <@case_input-slug:my_field> or :case_input{#slug:my_field}, which are rewritten to use IDs on import.
case_description Optional The case description template. Supports markdown and field mentions, which are rewritten to use field slugs on export and back to IDs on import.
priority Optional The case priority - critical, high, medium, low or info.
tag_names Optional An array of tag name strings. Tag IDs from the source team are resolved to names on export and recreated on the destination team on import.
sub_status Optional An object describing the case sub-status, with keys name, parent_status (open or closed), and icon. Resolved from the source team's sub-status ID on export and matched or created on import.
assignee_emails Optional An array of user email addresses. Assignee IDs stored on the template are resolved to emails on export so the template can round-trip across tenants. Formula entries are preserved.
team_case_buttons Optional An array of button objects for downstream actions associated with the case. Each object has button_type (one of webhook, story, page, or url), url (tenant-specific webhook URLs may need updating after import to another tenant), label (tooltip), and button_text (text shown on the button).
blocks Optional An array of block objects associated with the case. Each object has block_type, title, and an elements array whose shape varies by block_type. Field mentions inside block element content are rewritten to use field slugs on export.
team_case_tasks Optional An array of task objects associated with the case. Each object has description and an optional assignee_emails array; assignee IDs stored on the task are resolved to emails on export.
closure_conditions Optional An array of closure requirements in the form of a set of formula rules that need to evaluate to true to enable the closing of a case. Each entry has a name and a formula.
metadata Optional Case-related metadata represented as key-value pairs.

Sample response

{
  "schema_version": 1,
  "exported_at": "2026-05-25T10:00:00Z",
  "templates": [
    {
      "name": "Phishing investigation",
      "emoji": "🎣",
      "options": {
        "case_name": "Phishing report for <<recipient>>",
        "case_description": "Investigate reported phishing email from <@case_input-slug:reporter_email>.",
        "priority": "high",
        "tag_names": ["phishing", "email"],
        "sub_status": {
          "name": "Triage",
          "parent_status": "open",
          "icon": "in_progress"
        },
        "assignee_emails": ["analyst@example.com"],
        "team_case_buttons": [
          {
            "button_type": "page",
            "url": "https://tenant.tines.com/pages/55e94b9b4e26175051c0287f4259363f/",
            "label": "Isolate host and give reason",
            "button_text": "Open form"
          }
        ],
        "blocks": [
          {
            "title": "Investigation notes",
            "block_type": "note",
            "elements": [
              {
                "content": "Initial triage required for reporter <@case_input-slug:reporter_email>.",
                "note_type": "text",
                "color": "gold"
              }
            ]
          }
        ],
        "team_case_tasks": [
          {
            "description": "Review headers and attachments",
            "assignee_emails": ["analyst@example.com"]
          }
        ],
        "closure_conditions": [
          {
            "name": "has at least 1 assignee",
            "formula": "=SIZE(team_case.assignees) > 0"
          }
        ],
        "metadata": {
          "source": "user_report"
        }
      },
      "input_values": [
        {
          "field_slug": "reporter_email",
          "value": "user@example.com"
        }
      ],
      "field_definitions": [
        {
          "slug": "reporter_email",
          "name": "Reporter email",
          "input_type": "string",
          "sensitive": false
        }
      ]
    }
  ]
}
Was this helpful?