Customer Notes

Manage notes attached to customer records. Notes are useful for recording special requests, preferences, or communication history.

List Notes

Get all notes for a customer.

Endpoint

GET /v1/customers/{id}/notes

Query Parameters

Parameter	Type	Description
page	integer	Page number (default: 1)
per_page	integer	Items per page (default: 20, max: 100)
sort	string	Sort field: id, created_at
order	string	Sort direction: asc or desc

Example Request

curl -X GET "https://app.equipdash.com/api/v1/customers/123/notes" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "data": [
    {
      "id": 1,
      "note": "Customer prefers morning pickup times.",
      "created_by": {
        "id": 5,
        "name": "Jane Admin"
      },
      "created_at": "2026-02-01T10:00:00+00:00"
    },
    {
      "id": 2,
      "note": "VIP customer - offer 10% loyalty discount.",
      "created_by": {
        "id": 3,
        "name": "Manager Mike"
      },
      "created_at": "2026-01-15T14:30:00+00:00"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 20,
    "total": 2,
    "total_pages": 1
  }
}

---

Add Note

Add a new note to a customer record.

Endpoint

POST /v1/customers/{id}/notes

Request Body

Field	Type	Required	Description
note	string	Yes	Note content (max 5000 chars)

Example Request

curl -X POST "https://app.equipdash.com/api/v1/customers/123/notes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "note": "Customer requested we hold their gear for an extra day without charge."
  }'

Response

{
  "data": {
    "id": 3,
    "note": "Customer requested we hold their gear for an extra day without charge.",
    "created_by": null,
    "created_at": "2026-02-01T15:00:00+00:00"
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-02-01T15:00:00+00:00"
  }
}

note

Notes created via API will have created_by as null since there's no user context. When creating notes through the admin interface, the user who created the note is recorded.

---

Delete Note

Delete a note from a customer record.

Endpoint

DELETE /v1/customers/{id}/notes/{noteId}

Example Request

curl -X DELETE "https://app.equipdash.com/api/v1/customers/123/notes/3" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Returns 204 No Content on success.

---

Use Cases

CRM Integration

Sync customer notes with your CRM system:

# Get all customer notes
curl "https://app.equipdash.com/api/v1/customers/123/notes" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Add note from CRM
curl -X POST "https://app.equipdash.com/api/v1/customers/123/notes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"note": "Customer called about upcoming booking - confirmed details"}'

Support Ticketing

Add notes from support ticket resolutions:

curl -X POST "https://app.equipdash.com/api/v1/customers/123/notes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"note": "Resolved support ticket #4521 - Refunded late fee as goodwill gesture"}'

Special Requirements

Record customer preferences and requirements:

curl -X POST "https://app.equipdash.com/api/v1/customers/123/notes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"note": "Customer has mobility requirements - ensure ground floor pickup location"}'