List Appointments

GET

/appointments

The lastUpdatedOnDateTime only updates when the appointment object is updated, not when the status is updated as this is stored as a seperate object in Commusoft.

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

Bodyapplication/json

🟠429429 Too many requests

🟠401401 Unauthorised

🟠403403 Forbidden

🟠404404 Not found

🟠409409 Conflict

Request Example

Shell

JavaScript

Java

Swift

curl --location '/appointments' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "meta": {
        "totalRecords": 0,
        "serverTime": "string"
    },
    "pagination": {
        "hasMore": true,
        "nextCursor": 0,
        "prevCursor": 0
    },
    "data": [
        {
            "id": 0,
            "createdOnDateTime": "2019-08-24T14:15:22.123Z",
            "lastUpdatedOnDateTime": "2019-08-24T14:15:22.123Z",
            "parentType": "opportunity",
            "parentID": 0,
            "date": "2019-08-24",
            "hasTime": true,
            "timeSlot": "am",
            "startTime": "14:15:22.123Z",
            "endTime": "14:15:22.123Z",
            "serviceWindow": "string",
            "description": "string",
            "notes": "string",
            "assigneeUserID": 0,
            "assigneeUserName": "string",
            "currentStatus": "accept",
            "links": {
                "property": "string",
                "estimate": "string",
                "opportunity": "string",
                "job": "string",
                "arriveFeedback": "string",
                "onsiteTasks": "string",
                "jobReportFeedback": "string"
            }
        }
    ]
}

Modified at 2026-10-30 07:25:25

List forms

Appointments