Service Reminder Information

Fetch Service Reminder Information

To retrieve the details of a service reminder, you must provide the Service Reminder ID in your request. This ID acts as a unique identifier for the reminder you want to access.

Requirements

Before making the request, please ensure the following:

You have a valid Service Reminder ID that corresponds to the reminder you want to fetch.

You have the required permissions to access the reminder details. If you’re unsure about your access level, please check with your admin or system support.

Response Data

Once your request is successful, the response will provide the following important details:

Reminder Status: The current status of the service reminder. This can be one of the following:

Pending: The reminder has been acknowledged, but action has not yet been taken. It is waiting to be addressed.

Sent: The reminder has been sent out, but no action has been taken, and it is awaiting further attention.

Converted: The reminder has been successfully processed and is now active or in effect.

Customer Information: Detailed information about the customer linked to the service reminder, such as:

Customer name

Contact details

Address information

Reminder Code: A unique identifier assigned to each service reminder. This helps in distinguishing different reminders.

Associated Booking and Service History: This section includes past services and bookings related to the reminder, showing what has been done before:

Past bookings

Service history

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Headers

Body

Example

{
    "success": true,
    "reminder": {
        "id": "",
        "code": "",
        "carId": "",
        "customerId": "",
        "workshopId": "",
        "lastServiceId": "",
        "lastBookingId": "",
        "newBookingId": "",
        "externalId": "",
        "car": {
            "id": "",
            "customerId": "",
            "rego": "",
            "year": 0,
            "make": "",
            "model": "",
            "badge": "",
            "vin": ""
        },
        "customer": {
            "id": "",
            "workshopId": "",
            "name": "",
            "firstName": "",
            "lastName": "",
            "email": "",
            "phone": "",
            "company": "",
            "address": "",
            "postcode": "",
            "suburb": ""
        },
        "category": "automated",
        "status": "pending",
        "date": "2025-07-03T03:30:00Z",
        "convertedDate": "2025-07-04T00:00:00Z",
        "smsSent": "2025-07-03T03:30:00Z",
        "smsSid": "",
        "customerPhone": "",
        "customerEmail": "",
        "emailSid": "",
        "emailSent": "2025-07-03T03:30:00Z",
        "createdAt": "2025-07-03T03:30:00Z",
        "updatedAt": "2025-07-04T00:00:00Z"
    }
}

🟠404Record Not Found

Fetch Service Reminder Information#

Requirements#

Response Data#

Request

Request Code Samples

Responses

Fetch Service Reminder Information

Requirements

Response Data