Skip to content
Pidgely Docs

API reference · Templates

List templates

GEThttps://api.pidgely.com/templates
View as Markdown

Lists templates, newest first (default page size 20).

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Query parameters

Name Type Required Description
limit integer No Page size (1-100). Between 1 and 100.
after string No Id of the last item of the previous page (older items). UUID.
before string No Id of the first item of the current page (newer items). UUID.

Request

Node.js
import { Pidgely } from 'pidgely';

const pidgely = new Pidgely(process.env.PIDGELY_API_KEY);

const { data, error } = await pidgely.templates.list();
console.log(data ?? error);
Python
import os
import pidgely

pidgely.api_key = os.environ["PIDGELY_API_KEY"]

result = pidgely.Templates.list()
print(result)
PHP
<?php

require __DIR__ . '/vendor/autoload.php';

$pidgely = Pidgely::client(getenv('PIDGELY_API_KEY'));

$result = $pidgely->templates->list();
var_dump($result);
Go
package main

import (
	"context"
	"fmt"
	"os"

	"github.com/pidgely/pidgely-go"
)

func main() {
	ctx := context.Background()
	client := pidgely.NewClient(os.Getenv("PIDGELY_API_KEY"))

	result, err := client.Templates.List(ctx, nil)
	if err != nil {
		panic(err)
	}
	fmt.Println(result)
}
Ruby
require "pidgely"

Pidgely.api_key = ENV["PIDGELY_API_KEY"]

result = Pidgely::Templates.list()
puts result
cURL
curl -X GET 'https://api.pidgely.com/templates' \
  -H "Authorization: Bearer $PIDGELY_API_KEY"

Response

200 OK

JSON
{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "template",
      "id": "0199d7f7-7e2f-7b5c-8a4d-1c9e3f6a0b27",
      "current_version_id": "0199d7f7-8a11-7e3b-b5c4-0d2f6a9e1c83",
      "alias": "order-confirmation",
      "name": "Order confirmation",
      "created_at": "2026-10-12 16:44:41.000000+00",
      "updated_at": "2026-10-12 16:44:41.000000+00",
      "status": "published",
      "published_at": "2026-10-12 16:44:41.000000+00",
      "from": "Acme <orders@acme.com>",
      "subject": "Order {{{ORDER_ID}}} confirmed",
      "reply_to": [],
      "has_unpublished_versions": false
    }
  ]
}

Response fields

Name Type Required Description
object string Yes Object type. One of list.
has_more boolean Yes Whether another page exists.
data object[] Yes Items of this page.
data[].object string No Object type.
data[].id string No Unique id (UUID). UUID.
data[].current_version_id string | null No Id of the published version, or null.
data[].alias string | null No Unique, human-readable key you can use instead of the id: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$, not a UUID.
data[].name string No Display name.
data[].created_at string No Timestamp in UTC (2026-10-12 16:44:41.000000+00).
data[].updated_at string No Timestamp in UTC (2026-10-12 16:44:41.000000+00).
data[].status string No Current status. One of draft, published.
data[].published_at string | null No Timestamp in UTC, or null.
data[].from string No —
data[].subject string No Subject line, up to 998 bytes. Required unless a template provides it.
data[].reply_to string[] No Reply-To address or list of addresses.
data[].html string No HTML body. html or text is required (unless you send with a template).
data[].text string No —
data[].variables object[] No Typed variables (up to 50). FIRST_NAME, LAST_NAME, EMAIL and UNSUBSCRIBE_URL are reserved.
data[].variables[].id string No Unique id (UUID). UUID.
data[].variables[].key string No Variable name, ^[A-Za-z0-9_]{1,50}$.
data[].variables[].type string No string or number. One of string, number.
data[].variables[].fallback_value string | number | null No Used when a send does not provide the variable. Must match the type.
data[].variables[].created_at string No Timestamp in UTC (2026-10-12 16:44:41.000000+00).
data[].variables[].updated_at string No Timestamp in UTC (2026-10-12 16:44:41.000000+00).
data[].has_unpublished_versions boolean No Whether the draft differs from the published version.

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
422 validation_error A field is missing or invalid; message names it.
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.