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": "2025-06-24T08:51:42.416Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "f85b4a40-cb40-4c1c-a1e1-7df966116457",
        "tenantId": "207276e5-59e3-4575-92fe-f138f0b8bb54",
        "name": "Send Email",
        "type": {
          "id": "dd15edf8-99de-4c32-9a3d-f77bf416d263",
          "tenantId": "e9a3e41e-7fcf-4f7a-9993-1077a9a05240",
          "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"
      }
    ]
  }
}

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:

"9854c4f3-63df-4dbe-b116-e509a5c3a4d7"

​
typeId
string

Action Type ID

Example:

"39b99897-d12a-4529-ae62-501b52d80ccd"

​
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:

"2025-06-24T08:51:42.416Z"

​
message
string
required
Example:

"Success"

​
data
object