List Templates

Retrieves a list of templates with optional filters for organization, language, and status.

GET /templates/

cURL

cURL

curl --request GET \
  --url https://api.{environment}.corti.app/v2/templates/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Tenant-Name: <tenant-name>'

import { CortiClient, CortiEnvironment } from "@corti/sdk";

const client = new CortiClient({
    environment: CortiEnvironment.Eu,
    auth: {
        clientId: "YOUR_CLIENT_ID",
        clientSecret: "YOUR_CLIENT_SECRET"
    },
    tenantName: "YOUR_TENANT_NAME"
});
await client.templates.list();

using Corti;

var client = new CortiClient(
    "TENANT_NAME",
    CortiClientEnvironment.Eu,
    new CortiClientAuth.ClientCredentials("client_id", "client_secret")
);
await client.Templates.ListAsync(new TemplatesListRequest());

import requests

url = "https://api.{environment}.corti.app/v2/templates/"

headers = {
    "Tenant-Name": "<tenant-name>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.{environment}.corti.app/v2/templates/",
  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: Bearer <token>",
    "Tenant-Name: <tenant-name>"
  ],
]);

$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.{environment}.corti.app/v2/templates/"

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

	req.Header.Add("Tenant-Name", "<tenant-name>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.{environment}.corti.app/v2/templates/")
  .header("Tenant-Name", "<tenant-name>")
  .header("Authorization", "Bearer <token>")
  .asString();

200

{
  "data": [
    {
      "name": "<string>",
      "description": "<string>",
      "key": "<string>",
      "status": "<string>",
      "templateSections": [
        {
          "sort": 123,
          "section": {
            "name": "<string>",
            "key": "<string>",
            "description": "<string>",
            "defaultWritingStyle": {
              "name": "<string>"
            },
            "type": "<string>",
            "translations": [
              {
                "languageId": "<string>",
                "name": "<string>",
                "description": "<string>"
              }
            ],
            "updatedAt": "2023-11-07T05:31:56Z",
            "alternateName": "<string>",
            "defaultFormatRule": {
              "name": "<string>"
            },
            "additionalInstructions": "<string>",
            "content": "<string>",
            "documentationMode": "global_sequential"
          }
        }
      ],
      "translations": [
        {
          "languageId": "<string>",
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "updatedAt": "2023-11-07T05:31:56Z",
      "additionalInstructions": "<string>",
      "documentationMode": "global_sequential"
    }
  ]
}

{
  "requestid": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "validationErrors": [
    {}
  ]
}

{
  "requestid": "<string>",
  "status": 123,
  "type": "<string>",
  "detail": "<string>",
  "validationErrors": [
    {}
  ]
}

Authorizations

Authorization · string · header · required

Input your token

Headers

Tenant-Name · string · required

Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.

Example:

"base"

Query Parameters

org · string[]

Filter templates by organization.

lang · string[]

Filter templates by language.

status · string[]

Filter templates by their status.

Response

200

application/json

List of Templates

data · object[] · required

List of filtered templates

Show child attributes