List action types

GET /v1/action-types

List action types

cURL

curl --request GET \
  --url https://staging.api.us.aptlydone.com/settings/v1/action-types

200

{
  "statusCode": 200,
  "timestamp": "2026-01-08T06:33:20.788Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "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"
      }
    ]
  }
}

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:

"b4e6469e-1145-483c-98bb-e5eafd611b18"

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

statusCode · number · required

Example:

200

timestamp · string · required

Example:

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

message · string · required

Example:

"Success"

data · object

Show child attributes