---
title: "List any messages scheduled for the organization"
method: GET
path: "/scheduledmessages"
tags: ["Scheduled Messages"]
---

# List any messages scheduled for the organization

`GET /scheduledmessages`

## Request

- Base URL: `https://api.sprucehealth.com/v1`
- URL: `https://api.sprucehealth.com/v1/scheduledmessages`
- Auth: HTTP bearer

This operation lists the messages that are scheduled to be sent from the organization.

## Query parameters

- `paginationToken` string: Token given in a previous response to allow requesting the next page

## Response `200`

An array of messages that are scheduled for the organization

- object
  - `hasMore` boolean, required
  - `paginationToken` string: Token given in a previous response to allow requesting the next page
  - `scheduledMessages` ScheduledMessage[], required
    - `conversationId` string, required: Spruce's conversation ID
    - `createdAt` string, date-time, required: The date and time the scheduled message was created
    - `id` string, required: Spruce's scheduled message ID
    - `isInternalNote` boolean, required: If the conversation item is an internal note - which is visible only to the posting side of the conversation.
    - `message` ScheduledMessageMessage, required
      - `attachments` ConversationItemAttachment[], required: Attachments for the scheduled message
        - `data` union
          - ConversationItemAudioAttachment
            - `mimetype` string, required: The mimetype of the audio attachment.
            - `signedUrl` SignedUrl, required
              - …
            - `transcription` ConversationItemTranscription
              - …
          - ConversationItemDocumentAttachment
            - `mimetype` string, required: The mimetype of the document attachment.
            - `name` string, required: The name associated with the attached document.
            - `signedUrl` SignedUrl, required
              - …
          - ConversationItemEntityProfileAttachment
            - `title` string, required: The title associated with the attached entity profile.
            - `url` string, required: The URL of the entity profile.
          - ConversationItemImageAttachment
            - `mimetype` string, required: The mimetype of the image attachment.
            - `signedUrl` SignedUrl, required
              - …
          - ConversationItemVideoAttachment
            - `mimetype` string, required: The mimetype of the video attachment.
            - `signedUrl` SignedUrl, required
              - …
        - `title` string, required: The title of the attachment.
        - `type` 'audio' | 'carePlan' | 'document' | 'entityProfile' | 'genericUrl' | 'image' | 'paymentRequest' | 'video' | 'visit', required: The type of the attachment.
      - `pagedInternalMemberIds` string[], required: The internal member ids that are paged in the scheduled message.
      - `text` string, required: The text of the conversation item. If the conversation item contains pages, they will be listed in the pages property.
    - `modifiedAt` string, date-time, required: The date and time the scheduled message was modified
    - `object` string, required: String representing the object's type
    - `scheduledToSendAt` string, date-time, required: The date and time the message is scheduled to be sent
    - `sendAsInternalMemberId` string, required: The id of a team or teammate in the organization
    - `sentConversationItemId` string: The id of the conversation item that was created when the scheduled message was sent. This is absent until the message has been sent.
  - `totalCount` integer, required

## Other responses

- `400`: bad request
- `500`: unexpected error

## Changes

- **2026-11-03** `06e7a37de1ce`: 1 info
  - added the optional property `scheduledMessages/items/sentConversationItemId` to the response with the `200` status

[Operation history](https://skmtc.dev/sprucehealth/apis/spruce-health-api/changes/scheduledmessages/get.md)

---

[API](https://skmtc.dev/sprucehealth/apis/spruce-health-api.md) - [All operations](https://skmtc.dev/sprucehealth/apis/spruce-health-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sprucehealth/apis/spruce-health-api/revisions/06e7a37de1ce?raw)
