Skip to main content
GET
/
v1
/
action-templates
List action templates
curl --request GET \
  --url https://staging.api.us.aptlydone.com/settings/v1/action-templates
{
  "statusCode": 200,
  "timestamp": "2026-01-08T06:33:20.763Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "c0eb4afc-1629-489b-8024-b1b9511f53ab",
        "tenantId": "f9697668-d4ea-4d32-a424-1c66016c0953",
        "name": "Send Email",
        "type": {
          "id": "101c8f60-237f-4b8b-aa5f-d38ba764bc24",
          "tenantId": "8b9add9e-fb17-4e9d-b97f-3dfe6f5cd197",
          "type": "email",
          "typeIcon": "mail",
          "status": true,
          "isCustom": true,
          "isDeleted": false,
          "deletedAt": "2024-01-12T00:00:00.000Z",
          "createdAt": "2024-01-12T00:00:00.000Z",
          "updatedAt": "2024-01-12T00:00:00.000Z"
        },
        "description": "Template for sending notification emails",
        "source": "Source",
        "status": true,
        "isDeleted": false,
        "deletedAt": "2024-01-12T00:00:00.000Z",
        "createdAt": "2024-01-12T00:00:00.000Z",
        "updatedAt": "2024-01-12T00:00:00.000Z"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.aptlydone.com/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

​
page
number

Page number

Required range: x >= 1
Example:

1

​
limit
number

Number of items per page

Required range: 1 <= x <= 100
Example:

10

​
tenantId
string
required

Tenant ID

Example:

"0cfc0081-b6d0-4d5a-98d3-11d2c2da865b"

​
typeId
string

Action Type ID

Example:

"46e5831b-6e2d-4e85-b6d0-ecb499b34354"

​
search
string

Search by name

Example:

"Send Email"

​
sortBy
string

Field to sort by

Example:

"id"

​
sortOrder
enum<string>
default:asc

Sort order (asc/desc)

Available options:
asc,
desc
Example:

"asc"

Response

200 - application/json

Action templates list retrieved successfully

​
statusCode
number
required
Example:

200

​
timestamp
string
required
Example:

"2026-01-08T06:33:20.763Z"

​
message
string
required
Example:

"Success"

​
data
object