List Templates API

curl --request GET \
  --url https://api.trysiren.io/api/v1/public/template \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.trysiren.io/api/v1/public/template', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.trysiren.io/api/v1/public/template",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trysiren.io/api/v1/public/template"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.trysiren.io/api/v1/public/template")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "totalElements": 0,
    "totalPages": 0,
    "size": 0,
    "content": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "description": "string",
        "variables": [
          {
            "name": "string",
            "defaultValue": "string"
          }
        ],
        "tags": [
          "string"
        ],
        "draftVersion": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "version": 0,
          "status": "PUBLISHED_LATEST",
          "publishedAt": "2024-08-30T07:31:07.380Z"
        },
        "publishedVersion": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "version": 0,
          "status": "PUBLISHED_LATEST",
          "publishedAt": "2024-08-30T07:31:07.380Z"
        },
        "templateVersions": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "version": 0,
            "status": "PUBLISHED_LATEST",
            "publishedAt": "2024-08-30T07:31:07.380Z"
          }
        ]
      }
    ],
    "number": 0,
    "sort": {
      "empty": true,
      "unsorted": true,
      "sorted": true
    },
    "numberOfElements": 0,
    "first": true,
    "last": true,
    "pageable": {
      "offset": 0,
      "sort": {
        "empty": true,
        "unsorted": true,
        "sorted": true
      },
      "pageNumber": 0,
      "paged": true,
      "pageSize": 0,
      "unpaged": true
    },
    "empty": true
  },
  "error": null,
  "errors": null,
  "meta": null
}

{
  "data": null,
  "error": {
    "errorCode": "BAD_REQUEST",
    "message": "Bad request"
  },
  "errors": [
    {
      "errorCode": "BAD_REQUEST",
      "message": "Bad request"
    }
  ],
  "meta": null
}

{
  "data": null,
  "error": {
    "errorCode": "UNAUTHORISED",
    "message": "Unauthorised"
  },
  "errors": [
    {
      "errorCode": "UNAUTHORISED",
      "message": "Unauthorised"
    }
  ],
  "meta": null
}

{
  "data": null,
  "error": {
    "errorCode": "NOT FOUND",
    "message": "Not found"
  },
  "errors": [
    {
      "errorCode": "NOT FOUND",
      "message": "Not found"
    }
  ],
  "meta": null
}

GET

api

public

template

List Templates API

curl --request GET \
  --url https://api.trysiren.io/api/v1/public/template \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.trysiren.io/api/v1/public/template', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.trysiren.io/api/v1/public/template",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trysiren.io/api/v1/public/template"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.trysiren.io/api/v1/public/template")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "totalElements": 0,
    "totalPages": 0,
    "size": 0,
    "content": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "description": "string",
        "variables": [
          {
            "name": "string",
            "defaultValue": "string"
          }
        ],
        "tags": [
          "string"
        ],
        "draftVersion": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "version": 0,
          "status": "PUBLISHED_LATEST",
          "publishedAt": "2024-08-30T07:31:07.380Z"
        },
        "publishedVersion": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "version": 0,
          "status": "PUBLISHED_LATEST",
          "publishedAt": "2024-08-30T07:31:07.380Z"
        },
        "templateVersions": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "version": 0,
            "status": "PUBLISHED_LATEST",
            "publishedAt": "2024-08-30T07:31:07.380Z"
          }
        ]
      }
    ],
    "number": 0,
    "sort": {
      "empty": true,
      "unsorted": true,
      "sorted": true
    },
    "numberOfElements": 0,
    "first": true,
    "last": true,
    "pageable": {
      "offset": 0,
      "sort": {
        "empty": true,
        "unsorted": true,
        "sorted": true
      },
      "pageNumber": 0,
      "paged": true,
      "pageSize": 0,
      "unpaged": true
    },
    "empty": true
  },
  "error": null,
  "errors": null,
  "meta": null
}

{
  "data": null,
  "error": {
    "errorCode": "BAD_REQUEST",
    "message": "Bad request"
  },
  "errors": [
    {
      "errorCode": "BAD_REQUEST",
      "message": "Bad request"
    }
  ],
  "meta": null
}

{
  "data": null,
  "error": {
    "errorCode": "UNAUTHORISED",
    "message": "Unauthorised"
  },
  "errors": [
    {
      "errorCode": "UNAUTHORISED",
      "message": "Unauthorised"
    }
  ],
  "meta": null
}

{
  "data": null,
  "error": {
    "errorCode": "NOT FOUND",
    "message": "Not found"
  },
  "errors": [
    {
      "errorCode": "NOT FOUND",
      "message": "Not found"
    }
  ],
  "meta": null
}

string

required

Bearer token for API authentication. Format: Bearer {{apiToken}}

Query Parameters

string

Filter templates by tag names.

string

Search templates by field.

string

Sort templates by field.

integer

Page number for pagination. Default: 0.

integer

Number of items per page. Default: 10.

Response

object

integer

Total number of templates.

integer

Total number of pages.

integer

Page size.

array

List of template objects.

UUID

Template ID.

string

Template name.

string

Template description.

array

List of template variables.

string

Variable name.

string

Default value for the variable.

array

List of template tags.

object

Draft version details.

UUID

Version ID.

integer

Version number.

string

Version status (e.g., “PUBLISHED_LATEST”).

datetime

Timestamp of when the version was published.

object

Published version details.

UUID

Version ID.

integer

Version number.

string

Version status (e.g., “PUBLISHED_LATEST”).

datetime

Timestamp of when the version was published.

array

List of all template versions.

UUID

Version ID.

integer

Version number.

string

Version status (e.g., “PUBLISHED_LATEST”).

datetime

Timestamp of when the version was published.

integer

Current page number.

object

Sort information.

boolean

Whether the sort is empty.

boolean

Whether the sort is unsorted.

boolean

Whether the sort is sorted.

integer

Number of elements on this page.

boolean

Whether this is the first page.

boolean

Whether this is the last page.

object

Pageable information.

integer

Page offset.

object

Sort information.

boolean

Whether the sort is empty.

boolean

Whether the sort is unsorted.

boolean

Whether the sort is sorted.

integer

Page number.

boolean

Whether pagination is enabled.

integer

Page size.

boolean

Whether pagination is disabled.

boolean

Whether the result is empty.

object

string

The error code (e.g., BAD_REQUEST).

string

A human-readable error message.

array

List of error objects.

string

Error code.

string

Error message.

object

Metadata object.

{
  "data": {
    "totalElements": 0,
    "totalPages": 0,
    "size": 0,
    "content": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "description": "string",
        "variables": [
          {
            "name": "string",
            "defaultValue": "string"
          }
        ],
        "tags": [
          "string"
        ],
        "draftVersion": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "version": 0,
          "status": "PUBLISHED_LATEST",
          "publishedAt": "2024-08-30T07:31:07.380Z"
        },
        "publishedVersion": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "version": 0,
          "status": "PUBLISHED_LATEST",
          "publishedAt": "2024-08-30T07:31:07.380Z"
        },
        "templateVersions": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "version": 0,
            "status": "PUBLISHED_LATEST",
            "publishedAt": "2024-08-30T07:31:07.380Z"
          }
        ]
      }
    ],
    "number": 0,
    "sort": {
      "empty": true,
      "unsorted": true,
      "sorted": true
    },
    "numberOfElements": 0,
    "first": true,
    "last": true,
    "pageable": {
      "offset": 0,
      "sort": {
        "empty": true,
        "unsorted": true,
        "sorted": true
      },
      "pageNumber": 0,
      "paged": true,
      "pageSize": 0,
      "unpaged": true
    },
    "empty": true
  },
  "error": null,
  "errors": null,
  "meta": null
}

{
  "data": null,
  "error": {
    "errorCode": "BAD_REQUEST",
    "message": "Bad request"
  },
  "errors": [
    {
      "errorCode": "BAD_REQUEST",
      "message": "Bad request"
    }
  ],
  "meta": null
}

{
  "data": null,
  "error": {
    "errorCode": "UNAUTHORISED",
    "message": "Unauthorised"
  },
  "errors": [
    {
      "errorCode": "UNAUTHORISED",
      "message": "Unauthorised"
    }
  ],
  "meta": null
}

{
  "data": null,
  "error": {
    "errorCode": "NOT FOUND",
    "message": "Not found"
  },
  "errors": [
    {
      "errorCode": "NOT FOUND",
      "message": "Not found"
    }
  ],
  "meta": null
}

Status Codes

200 - OK
400 - BAD REQUEST
401 - UNAUTHORISED
404 - NOT FOUND

End Chat Session Get All Channel Templates

User Management

Workflow APIs

Chat Node APIs (Beta)

Template APIs

Provider APIs

Webhook APIs

Messaging APIs

List Templates API

Header

Query Parameters

Response

Status Codes

​Header

​Query Parameters

​Response

​Status Codes

Header

Query Parameters

Response

Status Codes