Skip to main content
GET
/
api
/
templates
List templates
curl --request GET \
  --url https://core-api.getaptly.com/api/templates \
  --header 'x-token: <api-key>'
{
  "data": [
    {
      "_id": "<string>",
      "companyId": "<string>",
      "name": "<string>",
      "archived": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
x-token
string
header
required

Query Parameters

​
companyId
string

Company ID. Required when using a partner token; resolved automatically for API key and delegate token auth.

​
templateType
enum<string>

Filter by template type.

Available options:
sms,
email,
form,
eSignature,
pdf,
blockDocument
​
aptletUuid
string

Filter by associated board UUID.

​
archived
boolean

Filter by archived status.

Response

Array of templates.

​
data
object[]