GET
/
api
/
v1
/
public
/
template
List Templates API
curl --request GET \
  --url https://api.trysiren.io/api/v1/public/template \
  --header 'Authorization: <authorization>'
{
  "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
}
​
Authorization
string
required
Bearer token for API authentication. Format: Bearer {{apiToken}}

​
Query Parameters

​
tagNames
string
Filter templates by tag names.
​
search
string
Search templates by field.
​
sort
string
Sort templates by field.
​
page
integer
Page number for pagination. Default: 0.
​
size
integer
Number of items per page. Default: 10.

​
Response

​
data
object
​
totalElements
integer
Total number of templates.
​
totalPages
integer
Total number of pages.
​
size
integer
Page size.
​
content
array
List of template objects.
​
id
UUID
Template ID.
​
name
string
Template name.
​
description
string
Template description.
​
variables
array
List of template variables.
​
name
string
Variable name.
​
defaultValue
string
Default value for the variable.
​
tags
array
List of template tags.
​
draftVersion
object
Draft version details.
​
id
UUID
Version ID.
​
version
integer
Version number.
​
status
string
Version status (e.g., “PUBLISHED_LATEST”).
​
publishedAt
datetime
Timestamp of when the version was published.
​
publishedVersion
object
Published version details.
​
id
UUID
Version ID.
​
version
integer
Version number.
​
status
string
Version status (e.g., “PUBLISHED_LATEST”).
​
publishedAt
datetime
Timestamp of when the version was published.
​
templateVersions
array
List of all template versions.
​
id
UUID
Version ID.
​
version
integer
Version number.
​
status
string
Version status (e.g., “PUBLISHED_LATEST”).
​
publishedAt
datetime
Timestamp of when the version was published.
​
number
integer
Current page number.
​
sort
object
Sort information.
​
empty
boolean
Whether the sort is empty.
​
unsorted
boolean
Whether the sort is unsorted.
​
sorted
boolean
Whether the sort is sorted.
​
numberOfElements
integer
Number of elements on this page.
​
first
boolean
Whether this is the first page.
​
last
boolean
Whether this is the last page.
​
pageable
object
Pageable information.
​
offset
integer
Page offset.
​
sort
object
Sort information.
​
empty
boolean
Whether the sort is empty.
​
unsorted
boolean
Whether the sort is unsorted.
​
sorted
boolean
Whether the sort is sorted.
​
pageNumber
integer
Page number.
​
paged
boolean
Whether pagination is enabled.
​
pageSize
integer
Page size.
​
unpaged
boolean
Whether pagination is disabled.
​
empty
boolean
Whether the result is empty.
​
error
object
​
errorCode
string
The error code (e.g., BAD_REQUEST).
​
message
string
A human-readable error message.
​
errors
array
List of error objects.
​
errorCode
string
Error code.
​
message
string
Error message.
​
meta
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
}

​
Status Codes

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