> ## Documentation Index > Fetch the complete documentation index at: https://docs.periskope.app/llms.txt > Use this file to discover all available pages before exploring further. # Get Scheduled Message > Retrieves a scheduled message by its scheduled_id. ## OpenAPI ````yaml api-reference/openapi-generated.json GET /v1/message/scheduled/{scheduled_id} openapi: 3.0.3 info: title: Periskope API version: 1.0.0 description: >- Periskope external API. Responses use a flat, unwrapped shape: most endpoints return the resource at the top level, and list endpoints return a wrapper object with pagination inline (e.g. `{ from, to, count, chats: [...] }`). The documented response schemas describe these shapes directly. servers: - url: https://api.periskope.app security: - bearerAuth: [] paths: /v1/message/scheduled/{scheduled_id}: get: tags: - Scheduled Messages summary: Get a scheduled message by id description: Retrieves a scheduled message by its scheduled_id. operationId: getScheduledMessageById parameters: - schema: type: string minLength: 1 description: >- Id of the scheduled message — the scheduled_id returned when it was created example: 00000000-0000-0000-0000-000000000000 required: true description: >- Id of the scheduled message — the scheduled_id returned when it was created name: scheduled_id in: path responses: '200': description: The scheduled message content: application/json: schema: $ref: '#/components/schemas/ScheduledMessage' examples: default: summary: Response body value: scheduled_id: 00000000-0000-0000-0000-000000000000 org_id: 00000000-0000-0000-0000-000000000000 org_phone: 911111111111@c.us chat_id: 120363000000000000@g.us message_payload: message: 'Weekly reminder: submit your report' media: {} scheduled_at: '2026-02-01T09:00:00.000Z' is_repeat: true repeat_config: repeat_interval: week repeat_value: 1 repeat_days: - monday - friday repeat_ends: '2026-12-31T00:00:00Z' status: scheduled skip_next: false paused_at: null updated_at: null performed_by: api created_at: '2026-01-15T09:30:00.000Z' '401': description: Invalid, expired or missing API token content: application/json: examples: error: summary: Invalid, expired or missing API token value: code: UNAUTHORIZED_ERROR message: Invalid bearer auth token status: 401 schema: type: object properties: code: type: string example: UNAUTHORIZED_ERROR message: type: string example: Invalid bearer auth token status: type: integer example: 401 example: code: UNAUTHORIZED_ERROR message: Invalid bearer auth token status: 401 '404': description: Scheduled message not found content: application/json: examples: error: summary: Scheduled message not found value: code: NOT_FOUND_ERROR message: Scheduled message not found status: 404 schema: type: object properties: code: type: string example: NOT_FOUND_ERROR message: type: string example: Scheduled message not found status: type: integer example: 404 example: code: NOT_FOUND_ERROR message: Scheduled message not found status: 404 '422': description: Request validation failed content: application/json: examples: error: summary: Request validation failed value: code: VALIDATION_ERROR message: Request validation failed status: 422 fields: body.chat_id: message: chat_id is required schema: type: object properties: code: type: string example: VALIDATION_ERROR message: type: string example: Request validation failed status: type: integer example: 422 fields: type: object additionalProperties: type: object properties: message: type: string value: {} example: body.chat_id: message: chat_id is required example: code: VALIDATION_ERROR message: Request validation failed status: 422 fields: body.chat_id: message: chat_id is required '429': description: Rate limit exceeded content: application/json: examples: error: summary: Rate limit exceeded value: code: RATE_LIMIT_ERROR message: You can only make 100 requests per second status: 429 schema: type: object properties: code: type: string example: RATE_LIMIT_ERROR message: type: string example: You can only make 100 requests per second status: type: integer example: 429 example: code: RATE_LIMIT_ERROR message: You can only make 100 requests per second status: 429 '500': description: Internal server error content: application/json: examples: error: summary: Internal server error value: code: UNKNOWN_ERROR message: Internal server error status: 500 schema: type: object properties: code: type: string example: UNKNOWN_ERROR message: type: string example: Internal server error status: type: integer example: 500 example: code: UNKNOWN_ERROR message: Internal server error status: 500 security: - bearerAuth: [] x-codeSamples: - lang: typescript label: TypeScript source: |- import { PeriskopeApi } from '@periskope/periskope-client'; const client = new PeriskopeApi({ authToken: 'YOUR_API_KEY', }); async function main() { const response = await client.scheduledMessages.getScheduledMessageById({ scheduled_id: '00000000-0000-0000-0000-000000000000', }); console.log(response); } main(); - lang: bash label: cURL source: >- curl -X GET 'https://api.periskope.app/v1/message/scheduled/00000000-0000-0000-0000-000000000000' \ -H 'Authorization: Bearer YOUR_API_KEY' components: schemas: ScheduledMessage: type: object properties: scheduled_id: type: string description: Unique id of the scheduled message example: 00000000-0000-0000-0000-000000000000 org_id: type: string description: Id of the organization the scheduled message belongs to example: 00000000-0000-0000-0000-000000000000 org_phone: type: string description: >- Org phone (WhatsApp account) the message is sent from, as country code + number suffixed with @c.us example: 911111111111@c.us chat_id: type: string description: >- Chat the message is sent to — @c.us for 1-1 chats, @g.us for group chats example: 120363000000000000@g.us message_payload: type: object properties: message: type: string description: Text content of the scheduled message example: 'Weekly reminder: submit your report' media: type: object description: Attachment of the scheduled message, when present description: Content sent on every run — same shape as POST /message/send scheduled_at: type: string description: >- When the next run happens, as an ISO 8601 timestamp. For repeating messages this advances after every run. example: '2026-02-01T09:00:00.000Z' is_repeat: type: boolean description: Whether the message repeats or sends once example: true repeat_config: $ref: '#/components/schemas/RepeatConfig' status: type: string enum: - scheduled - paused - completed description: >- Lifecycle status: 'scheduled' (waiting for the next run), 'paused' (runs are skipped) or 'completed' example: scheduled skip_next: type: boolean description: When true, the next run is skipped once and the series continues example: false paused_at: type: string description: >- When the schedule was paused, as an ISO 8601 timestamp. null while not paused. updated_at: type: string description: >- When the schedule completed (one-time message sent, or series ended), as an ISO 8601 timestamp. null while pending. performed_by: type: string description: 'Who created the schedule: a member email, or "api"' example: api created_at: type: string description: When the schedule was created, as an ISO 8601 timestamp example: '2026-01-15T09:30:00.000Z' description: >- A scheduled message — content sent to a chat at scheduled_at, once or on a repeating series RepeatConfig: type: object properties: repeat_interval: type: string enum: - day - week - month description: >- Unit of repetition: 'day', 'week' or 'month'. Required for repeating messages. example: week repeat_value: type: integer minimum: 1 description: >- Every how many intervals between runs, e.g. 2 with repeat_interval week = every 2 weeks. Defaults to 1. Not applied when repeat_days is set — the schedule then runs on the listed weekdays instead. example: 1 repeat_days: type: array items: type: string enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday description: >- Only for repeat_interval 'day': restrict runs to these weekdays, e.g. ['monday', 'friday']. The schedule then runs on each listed weekday (repeat_value is ignored). Empty or omitted allows every day. Not allowed for 'week' or 'month' intervals. example: - monday - friday repeat_ends: type: string description: >- When the series stops, as an ISO 8601 UTC timestamp. The series ends once the next run would fall after this time. Omit for no end date. example: '2026-12-31T00:00:00Z' description: How the message recurs. null for one-time messages. securitySchemes: bearerAuth: type: http scheme: bearer description: >- Your Periskope API token, sent as `Authorization: Bearer `. Generate one from the Periskope dashboard under **Settings → API & Webhooks**. API access requires an active Pro or Enterprise plan. ````