> ## 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. # List Scheduled Message Runs > Returns the run history of a scheduled message, newest first — each run records whether it sent, failed or was skipped, and the resulting message id. ## OpenAPI ````yaml api-reference/openapi-generated.json GET /v1/message/scheduled/{scheduled_id}/occurrences 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}/occurrences: get: tags: - Scheduled Messages summary: List the runs of a scheduled message description: >- Returns the run history of a scheduled message, newest first — each run records whether it sent, failed or was skipped, and the resulting message id. operationId: listScheduledMessageOccurrences 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 - schema: type: integer nullable: true minimum: 0 description: >- Number of records to skip before the first returned record. Use together with limit to paginate: page N is offset = N * limit. Defaults to 0. example: 0 required: false description: >- Number of records to skip before the first returned record. Use together with limit to paginate: page N is offset = N * limit. Defaults to 0. name: offset in: query - schema: type: integer minimum: 1 description: Maximum number of records to return in one page. Defaults to 1000. example: 1000 required: false description: Maximum number of records to return in one page. Defaults to 1000. name: limit in: query - schema: type: string description: Only runs at or after this time (ISO 8601). example: '2026-01-01T00:00:00Z' required: false description: Only runs at or after this time (ISO 8601). name: start_time in: query - schema: type: string description: Only runs at or before this time (ISO 8601). example: '2026-01-31T23:59:00Z' required: false description: Only runs at or before this time (ISO 8601). name: end_time in: query - schema: type: string enum: - 'true' - 'false' - pending description: >- Filter runs by outcome: 'true' (sent), 'false' (failed or skipped) or 'pending' (not resolved yet). example: 'false' required: false description: >- Filter runs by outcome: 'true' (sent), 'false' (failed or skipped) or 'pending' (not resolved yet). name: is_success in: query - schema: type: string enum: - asc - desc description: 'Sort by run time: ''asc'' or ''desc'' (default).' example: desc required: false description: 'Sort by run time: ''asc'' or ''desc'' (default).' name: sort_order in: query responses: '200': description: Paginated list of runs, newest first content: application/json: schema: type: object properties: from: type: integer description: >- 1-based index of the first record in this page (offset + 1). example: 1 to: type: integer description: 1-based index of the last record in this page. example: 20 count: type: integer description: >- Number of records in this page — the length of the `occurrences` array, not the total across all pages. example: 20 occurrences: type: array items: $ref: '#/components/schemas/ScheduledMessageOccurrence' description: The occurrences in this page. examples: default: summary: Response body value: from: 1 to: 20 count: 20 occurrences: - id: 00000000-0000-0000-0000-000000000000 scheduled_id: 00000000-0000-0000-0000-000000000000 chat_id: 120363000000000000@g.us sent_message_id: 00000000-0000-0000-0000-000000000000 message_id: null is_success: true remarks: null delivered_at: null 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.listScheduledMessageOccurrences({ 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/occurrences' \ -H 'Authorization: Bearer YOUR_API_KEY' components: schemas: ScheduledMessageOccurrence: type: object properties: id: type: string description: Unique id of the occurrence (run) example: 00000000-0000-0000-0000-000000000000 scheduled_id: type: string description: Id of the scheduled message the run belongs to example: 00000000-0000-0000-0000-000000000000 chat_id: type: string description: Chat the run sent to example: 120363000000000000@g.us sent_message_id: type: string description: >- Queue job id of the run — trackable via the queue endpoints while in flight. null when the run was skipped. example: 00000000-0000-0000-0000-000000000000 message_id: type: string description: >- message_id of the resulting message once submitted to WhatsApp. null until then. is_success: type: boolean description: >- Whether the run was handed to the phone successfully. null while the run is still pending. example: true remarks: type: string description: >- Failure or skip reason when the run did not send, e.g. 'paused', 'skipped', 'no_phone', 'phone_not_found'. null for successful runs. delivered_at: type: string description: >- When the run was delivered, as an ISO 8601 timestamp. null when it was not. created_at: type: string description: When the run happened, as an ISO 8601 timestamp example: '2026-01-15T09:30:00.000Z' description: One run of a scheduled message and its outcome 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. ````