List scheduled activities

GET

/scheduledActivities

Scheduled activities are tasks or activities that managers/office staff need to complete. Scheduled activities can be associated with customers, opportunities or jobs. Example "Call John Smith back about his appointment".

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200Success

application/json

Headers

Bodyapplication/json

🟠401401 Unauthorised

🟠403403 Forbidden

🟠404404 Not found

🟠409409 Conflict

🟠429429 Too many requests

Request Example

Shell

JavaScript

Java

Swift

curl --location '/scheduledActivities?associatedWith=property&associatedWithID=1426&limit=100&includeCount=true' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "meta": {
        "totalRecords": "string",
        "serverTime": "string"
    },
    "pagination": {
        "hasMore": "string",
        "nextCursor": 0,
        "prevCursor": 0
    },
    "data": [
        {
            "id": "string",
            "createdByType": 0,
            "createdByID": 0,
            "createdByUser": "string",
            "createdOnDateTime": "2019-08-24T14:15:22.123Z",
            "lastUpdatedOnDateTime": "2019-08-24T14:15:22.123Z",
            "associatedWith": "property",
            "associatedWithID": 0,
            "activityType": "call",
            "status": true,
            "title": "string",
            "description": "string",
            "tags": [
                {
                    "tag": "string"
                }
            ],
            "assignedToo": [
                {
                    "id": 0,
                    "name": "string"
                }
            ],
            "dueDateTime": "2019-08-24T14:15:22.123Z",
            "property": {
                "id": 0,
                "fullName": "string",
                "addressLine": "string",
                "addressLine2": "string",
                "addressLine3": "string",
                "town": "string",
                "county": "string",
                "postcode": "string"
            },
            "opportunity": {
                "id": 0,
                "description": "string"
            },
            "job": {
                "id": 0,
                "description": "string"
            },
            "completed": {
                "completedOnDateTime": "2019-08-24T14:15:22.123Z",
                "completedByUserID": 0,
                "completedByUser": "string"
            },
            "links": {
                "property": "string",
                "opportunity": "string",
                "job": "string"
            }
        }
    ]
}

Modified at 2026-10-30 07:14:36

Assets

Scheduled activities