---
title: "List SMS Message Fragments"
method: GET
path: "/shop/sms-fragments"
tags: ["SmsFragments"]
---

# List SMS Message Fragments

`GET /shop/sms-fragments`

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

## Query parameters

- `site_id` string, uuid, required
- `offering_id` string, uuid
- `archived` boolean
- `page` integer
- `per_page` integer

## Response `200`

The SMS Message Fragments were successfully retrieved

- object
  - `data` SmsFragment[], required
    - `id` string, uuid, required — The ID of the SMS Fragment.
    - `name` string, required — The name of the SMS Fragment.
    - `message_type` 'basket_confirmed' | 'basket_cancelled_with_charge' | 'basket_cancelled_without_charge' | 'basket_reminder' | 'basket_follow_up' | 'pay_by_link_request' | 'billing_details_request', required — The type of message the SMS Fragment applies to.
    - `message` string, required — The contents of the SMS Fragment.
    - `priority` integer, required — The priority of the SMS Fragment. Fragments will be added to messages in ascending order.
    - `offerings` OfferingIdentifier[], required — An array of offerings which the SMS Fragment applies to. If empty, the SMS Fragment applies to no offerings.
      - `offering_id` string, mongo-id, required — The ID of the offering.
      - `offering_name` string, required — The name of the offering.
      - `offering_type` 'appointment' | 'appointment_enquiry' | 'area_booking' | 'course' | 'hotel_room_reservation' | 'membership' | 'package' | 'product' | 'session' | 'table_reservation' | 'voucher', required — Discriminator describing what kind of sellable item an `Offering` represents. The value determines which downstream schema (`Appointment`, `Session`, `Package`, etc.) the offering's `offering_id` resolves against, and which checkout/booking flow applies.
    - `site_id` string, uuid, required — The ID of the site the SMS Fragment is associated with.
    - `organisation_id` string, uuid, required — The ID of the organisation the SMS Fragment is associated with.
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `401` — The user is unauthenticated

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)