CUcustomer
SMS

List SMS

Changed on

Returns a paginated list of your SMS messages and a separate array of the folders they belong to. Each item in the list is a summary; to see an SMS's content, recipient, and sender, get the SMS.

get/v1/design_studio/sms

Request

  • Base URL
    https://api.customer.io
  • URL
    https://api.customer.io/v1/design_studio/sms
  • Auth
    none declared

Query parameters

pageinteger

The page number of results you want to display. Use with limit.

limitinteger

The maximum number of results per page.

parent_folder_idstring uuid

Filter by parent folder. Must reference an existing folder. If not set, the response filters by the root level directory.

To list only items in the root folder, leave parent_folder_id unset and only set direct_descendants_only to true.

direct_descendants_onlyboolean

When true, the response includes only the immediate children of the parent folder. When false, it includes the parent folder's entire subtree.

sort_by'created' | 'updated' | 'name'
sort_order'asc' | 'desc'
created_beforeinteger

Return records created before this time. Must be a unix timestamp.

created_afterinteger

Return records created after this time. Must be a unix timestamp.

updated_beforeinteger

Return records updated before this time. Must be a unix timestamp.

updated_afterinteger

Return records updated after this time. Must be a unix timestamp.

Response

Successful response

Example response

{
  "sms": [
    {
      "name": "Order shipped",
      "created": 1790000000,
      "updated": 1790000000
    }
  ],
  "folders": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Product Announcements",
      "parent_folder_id": null,
      "created": 1714732800,
      "updated": 1714732800
    }
  ],
  "meta": {
    "filters": {
      "parent_folder_id": "123e4567-e89b-12d3-a456-426614174000",
      "direct_descendants_only": true,
      "sort_by": "created",
      "sort_order": "desc",
      "created_before": 1714732800,
      "created_after": null,
      "updated_before": null,
      "updated_after": null
    }
  }
}

Changes