---
title: "Custom Messages List"
method: GET
path: "/api/v1/custom_messages/"
tags: ["custom_messages"]
---

# Custom Messages List

`GET /api/v1/custom_messages/`

List the existing custom_messages

## Query parameters

- `page` integer, nullable — The page number from which to start (0-based)
- `limit` integer — The maximum number of items to return
- `search_fields` CustomMessageProperties[] — String names of fields to search. Correspond by index to search field values
- `search_field_values` string[] — Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list
- `order_by` 'id' | 'name' | 'name_exact' | 'text' | 'label' | 'type' | 'updated_at' | 'agent_id'
- `order_by_direction` 'asc' | 'desc' — The direction in which to order list results, either ascending or descending.
- `fields` CustomMessageProperties[], nullable — The fields to include in the response
- `start_datetime` string, nullable — The start datetime for filtering results
- `end_datetime` string, nullable — The end datetime for filtering results

## Response `200`

Successful Response

- ListResponseCustomMessageResponse
  - `items` CustomMessageResponse[], required — List of items returned from the query
    - `name` string, required — The name of the custom message
    - `type` 'greeting' | 'email_template' — Type of custom message. Greeting is for voice; email_template is for email (subject + body).
    - `preamble` string, nullable — An optional preamble that will be delivered before the main message, regardless of whether the current time and date match a rule or the system uses the default message. Cannot contain the "{{ language.mode }}" tag. In the case of a voice conversation, the user will not be able to interrupt the preamble. Can be used for e.g. legal disclaimers that the user must always see/hear.
    - `text` string, required — The default message that the agent will deliver if no rules are set or no rules match the current timestamp. For email_template, this is the body.
    - `subject` string, nullable — Email subject. Required for email_template (in type_config); ignored otherwise.
    - `label` string, nullable — The label of the custom message
    - `repeat_after_language_change` boolean, required — If true, if the caller changes language using the language menu in the custom message, the message will be repeated in the new language (not including the language menu).
    - `rules` CustomMessageRule[] — Rules for time-specific message variants
      - `description` string, required — The description of the rule
      - `time_range_start` string, nullable — The start of the time range for the rule in 24-hour format hh:mm (should be null for "all day" cases)
      - `time_range_end` string, nullable — The end of the time range for the rule in 24-hour format hh:mm (should be null for "all day" cases)
      - `date` string, nullable — The date for the rule in YYYY-MM-DD format
      - `days_of_week` DayOfWeek[], nullable — The days of the week for the rule
      - `invert` boolean, required — Whether the rule logic should be inverted (i.e. "not")
      - `text` string, required — Message text associated with the rule
    - `id` integer, required — The ID of the custom message
    - `updated_at` string, date-time, required — Timestamp of the most recent update to the custom message
    - `agent_count` integer, nullable — The number of agents using the custom message
    - `last_updated_by` string, required — The email address of the user who most recently updated the custom message
  - `page` integer, required — The page number of the results (0-based)
  - `page_size` integer, required — The number of items returned per page
  - `total_pages` integer, nullable — The total number of pages of results given the indicated page size
  - `total_count` integer, nullable — The total number of items returned from the query

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/asksyllable/apis/syllablesdk.md) · [All operations](https://skmtc.net/asksyllable/apis/syllablesdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/asksyllable/syllablesdk/revisions/c37a273e80bf/schema)