GET
/
v1
/
action-types
List action types
curl --request GET \
  --url https://staging.api.us.aptlydone.com/settings/v1/action-types
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:51:42.422Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "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"
      }
    ]
  }
}

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:

"21a8aac4-7494-415f-bea3-1b7c26cdbaca"

​
search
string

Search by type name

Example:

"email"

​
status
boolean

Filter by status

Example:

true

​
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 types list retrieved successfully

The response is of type object.