Sign in
SmsFragments

List SMS Message Fragments

This endpoint retrieves a list of all the SMS Message Fragments for the given site.

get/shop/sms-fragments

Query parameters

site_idstring uuid required

Identifier of the site whose SMS fragments should be returned. SMS fragments are scoped per site so each location can author its own SMS templates. The caller's API key must have access to this site.

offering_idstring uuid

When provided, restricts the returned SMS fragments to those that apply to the given offering (treatment, class, course etc.). Omit to list SMS fragments across all offerings at the site.

archivedboolean

Whether to include archived resources in the response. When true, archived resources are returned; when false or omitted, only non-archived resources are returned.

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The SMS Message Fragments were successfully retrieved

Example response

{
  "data": [
    {
      "name": "Order Confirmation",
      "message": "Hi! Your order has been confirmed. We look forward to seeing you on Saturday 20th January at 12pm.\n",
      "priority": 10,
      "offerings": [
        {
          "offering_name": "Twilight massage",
          "offering_type": "appointment"
        }
      ]
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.