GET
/
v1
/
actions
List actions
curl --request GET \
  --url https://staging.api.us.aptlydone.com/actions/v1/actions \
  --header 'Authorization: Bearer <token>'
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:49:17.342Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 10,
    "data": [
      {
        "id": "9c01cfd5-3e64-4001-a8c5-0abb3fcdf62b",
        "actionId": "10001",
        "tenantId": "affb22b1-82ae-4226-8fac-bdb410f052c3",
        "actionName": "Review Financial Report",
        "description": "This action requires reviewing the Q1 financial report.",
        "actionTypeId": "e50b387b-856e-4d15-9c3b-ff2210afc42e",
        "actionType": {
          "id": "2b78310f-86fc-4b49-bec5-636960fb242a",
          "tenantId": "81e70d36-416d-42fd-9e36-1ffaafb5d737",
          "type": "Meeting",
          "typeIcon": "calendar",
          "status": true,
          "isCustom": false
        },
        "actionTemplateId": "97c8957d-6357-47c3-8caf-22409060e25e",
        "actionTemplate": {
          "id": "bad70123-b043-42d9-a80a-4d95099879e8",
          "tenantId": "f1dfaa64-a420-4b8b-b105-7cce3e530ce7",
          "name": "Weekly Status Meeting",
          "description": "Template for recurring team status meetings",
          "status": true,
          "type": {
            "id": "2b78310f-86fc-4b49-bec5-636960fb242a",
            "tenantId": "81e70d36-416d-42fd-9e36-1ffaafb5d737",
            "type": "Meeting",
            "typeIcon": "calendar",
            "status": true,
            "isCustom": false
          }
        },
        "actionPriorityId": "e206b561-7c41-4dba-9ddc-81c2b0e0a255",
        "actionStatusId": "3e35cc7c-44f2-49f0-8b97-40e5799be28d",
        "decisionId": "8af836e5-fe8e-4a78-a79c-5a30df373774",
        "decisionDisplayId": "10001",
        "delegationId": "907cb4b9-73a5-4d5a-bb26-492397a3c723",
        "delegationDisplayId": "10001",
        "documentId": "8b506f3d-da53-4c1c-9eb8-61dc4ef4185b",
        "documentDisplayId": "10001",
        "roleId": "8bc8cfce-7186-48b3-9403-cd35c10f4fcd",
        "link": "eyJ0ZW5hbnRJZCI6mZTktMmU5Zi00NDkxLTk5MTctYmFlYWUwY2UwYTQ2In0=",
        "ownerId": "232ada91-905f-4370-95b0-92b5060a03b9",
        "owner": {
          "id": "db1e5b12-5d8f-4856-aa2f-8e96bc41d655",
          "email": "[email protected]",
          "name": "Lorene Hilll",
          "firstName": "Esta",
          "lastName": "Bednar",
          "profileImageUrl": "https://picsum.photos/seed/uSdruM/1774/3925",
          "positions": [
            {
              "id": "c98d0654-88af-4357-92d9-619b13c0fa17",
              "positionName": "Managing Director - North",
              "autoProvisioned": false
            }
          ],
          "mobilePhone": "987654321"
        },
        "dueDate": "2025-04-15T14:00:00.000Z",
        "createdAt": "2025-03-01T09:00:00.000Z",
        "updateAt": "2025-03-01T09:00:00.000Z",
        "createdBy": "name of creator",
        "updateBy": "name of updator",
        "deletedOn": "2025-03-01T09:00:00.000Z",
        "deletedBy": "name of deletor",
        "copiedFrom": "bd4ca965-c78a-48d7-ab3c-54221b33e78a",
        "isDeleted": false,
        "isSystemGenerated": false,
        "assignees": [
          {
            "id": "96ab6544-06f4-431c-9791-e69171a77622",
            "assigneeId": "a3a5b11f-596b-4246-b15f-342ea6069f2a",
            "assignee": {
              "id": "db1e5b12-5d8f-4856-aa2f-8e96bc41d655",
              "email": "[email protected]",
              "name": "Lorene Hilll",
              "firstName": "Esta",
              "lastName": "Bednar",
              "profileImageUrl": "https://picsum.photos/seed/uSdruM/1774/3925",
              "positions": [
                {
                  "id": "c98d0654-88af-4357-92d9-619b13c0fa17",
                  "positionName": "Managing Director - North",
                  "autoProvisioned": false
                }
              ],
              "mobilePhone": "987654321"
            },
            "actionStatusId": "38ae697f-9f5a-45ba-9f34-bb625eb9e2fe",
            "actionStatusName": "TO DO",
            "actionTakenDate": "2025-03-10T09:00:00.000Z"
          }
        ],
        "files": [
          {
            "id": "0eb35285-ed5f-4401-b939-cc52295001bb",
            "fileUrl": "https://storage.example.com/files/report.pdf",
            "fileType": "pdf",
            "fileName": "fileName",
            "createdAt": "2025-03-05T14:30:00.000Z"
          }
        ],
        "priority": {
          "id": "f5d112a4-cb8d-4a77-bbeb-cbb0c0c4d83a",
          "actionPriorityName": "High",
          "isEnabled": true,
          "colorName": "green"
        },
        "status": {
          "id": "af137014-275e-4918-a937-0144950bc38f",
          "actionStatusName": "In Progress",
          "isEnabled": true
        },
        "permissions": [
          {
            "allowed": true,
            "relationship_key": "<string>"
          }
        ]
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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:

"70d6fb38-7474-4abd-9440-6948b3561c22"

​
filterType
enum<string>
default:all

Filter type (all, active, inactive, mine)

Available options:
all,
active,
inactive,
mine
​
statusIds
string

Action status IDs (comma separated)

Example:

"85df2654-c046-430a-b96a-f70cdca5321e, 33bd2335-f4b2-41af-8c5d-1bcd3f10c56f"

​
priorityIds
string

Action priority IDs (comma separated)

Example:

"7716c882-ab9a-4344-a55a-681d49629482, 4c8dc4bf-819b-4ac2-83cf-d97856bb895e"

​
typeIds
string

Action type IDs (comma separated)

Example:

"f5504d86-b769-468e-86e9-1d0bcb9cf297, 2746435e-df98-482a-b769-f9a78877706f"

​
ownerIds
string

Owner IDs (comma separated)

Example:

"6b70286c-896d-465a-9619-f27ced07f1d3, b99505b6-1e0b-46e1-8149-620ae1660775"

​
assigneeIds
string

Assignee IDs (comma separated)

Example:

"67188c63-a705-4caf-bf85-6082e7547c7d, 95b5ecf5-d533-45f7-abbc-70348b0e1bfe"

​
search
string

Search term for action name or description

Example:

"Financial"

​
duration
number

Duration (in month)

Example:

3

​
sortBy
string
default:createdAt

Field to sort by

Example:

"createdAt"

​
sortOrder
enum<string>
default:desc

Sort order (asc/desc)

Available options:
asc,
desc
Example:

"desc"

​
createdDateStart
string

Creation date range - start date

​
createdDateEnd
string

Creation date range - end date

​
dueStartDate
string

Due date date time for action

Example:

"2025-03-05T11:49:50.577Z"

​
dueEndDate
string

Due date date time for action

Example:

"2025-03-15T11:49:50.577Z"

Response

200 - application/json

Actions list retrieved successfully

The response is of type object.