SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
appointments

List notes on an appointment.

List notes on an appointment.

GEThttps://app.softsolz.uk/api/v1/services/appointments/appointments/{id}/notes

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Response

Response Body · array of objects

idstringNote id. A whole number sent as a string.
appointment_idstring | nullAppointment the note is on. A whole number sent as a string, or null.
customer_idstring | nullCustomer the note is on, when it was written against a customer. A whole number sent as a string, or null.
bodystringNote text.
visibilitystringinternal is for the team only, customer can be shown to the customer.
attachmentsarray of objectsFiles attached to the note.
author_user_idinteger | nullWorkspace member who wrote it. Null for notes added through the API.
created_atstringWhen the note was written.
updated_atstringWhen the note was last changed.
actor_namestring | nullName of the member who wrote it.
actor_emailstring | nullEmail of the member who wrote it.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/appointments/appointments/{id}/notes \
--header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": [
{
"id": "316",
"appointment_id": "650",
"customer_id": null,
"body": "Customer asked for a morning slot next time.",
"visibility": "internal",
"attachments": [],
"author_user_id": null,
"created_at": "2026-10-01T17:42:56.469Z",
"updated_at": "2026-10-01T17:42:56.469Z",
"actor_name": null,
"actor_email": null
}
],
"meta": {
"limit": 50,
"offset": 0,
"total": 1,
"has_more": false
}
}