Skip to main content

List

Description#

Retrieve a list of private templates.

Request#

HTTP Method: GET

Query ParameterDescription
N/A
Path ParameterDescription
N/A
curl -X GET \  https://<tenant-domain>/api/v1/admin/templates \  -H 'content-type: application/json' \  -H 'x-user-email: <email-address>' \  -H 'x-user-token: <api-token>'

Response#

A successful request will return a JSON Array of private templates in the Tines tenant.

Field description#

ParameterDescription
idTemplate ID.
nameTemplate name.
descriptionTemplate description.
agent typeType of action associated with the template.
agent optionsAction options.
vendorVendor name.
productProduct name.

Sample response#

{   "admin/templates":[   {      "id": "472463921472463921",      "name": Extract some text,      "description": "test",      "agent_type": "Event Transformation",      "agent_options": {          "mode": "extract",          "matchers": [              {                  "path": "{{.text}}",                  "regexp": "\\b[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,4}\\b",                  "to": "email_addresses"              },              {                  "path": "{{.text}}",                  "regexp": "https?:\\/\\/[\\S]+",                  "to": "urls"              }          ],          "message": "This is an optional message"      },      "vendor": "API",      "product": "API"   }   ],   "meta":{      "current_page":"https://<tenant-domain>/api/v1/admin/templates?page=1&per_page=20",      "previous_page":null,      "next_page":null,      "per_page":20,      "pages":1,      "count":1   }}