Skip to main content

List and read plans

List every plan​

GET /v1/message-plans

Returns every plan this business has, with its messages. Add ?scope=rentals to narrow to one level.

Requires settings:read.

Example​

curl "https://app.equipdash.com/api/v1/message-plans" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": [
    {
      "id": 3,
      "scope": "all",
      "label": "All bookings",
      "owner": null,
      "enabled": true,
      "messages": [
        {
          "id": 51,
          "plan_id": 3,
          "position": 0,
          "name": "Know before you go",
          "channel": "email",
          "audience": "booking_contact",
          "timing": {
            "anchor": "program_start",
            "offset_value": 2,
            "offset_unit": "days",
            "offset_direction": "before",
            "send_at_local_time": "09:00",
            "fixed_at": null,
            "summary": "2 days before the program starts"
          },
          "subject": "Getting ready for {{start_date}}",
          "enabled": true
        }
      ],
      "created_at": "2026-08-09T04:11:02+00:00",
      "updated_at": "2026-08-09T04:11:02+00:00"
    },
    {
      "id": 8,
      "scope": "rentals",
      "label": "Rentals",
      "owner": null,
      "enabled": true,
      "messages": []
    },
    {
      "id": 14,
      "scope": "item",
      "label": "This item",
      "owner": { "type": "Product", "id": 91, "name": "Touring kayak" },
      "enabled": true,
      "messages": []
    }
  ],
  "meta": { "request_id": "req_01J...", "timestamp": "2026-08-09T04:20:00+00:00" }
}

Query parameters​

ParameterTypeDescription
scopestringall, rentals, experiences, bundles or item

Read one plan​

GET /v1/message-plans/{id}

Returns the plan with its messages in order. Requires settings:read.

curl "https://app.equipdash.com/api/v1/message-plans/8" \
  -H "Authorization: Bearer YOUR_API_KEY"

A plan belonging to another business returns 404.