Skip to main content
TypeScript

Authorizations

Authorization
string
header
required

Your Periskope API token, sent as Authorization: Bearer <token>. Generate one from the Periskope dashboard under Settings → API & Webhooks. API access requires an active Pro or Enterprise plan.

Path Parameters

scheduled_id
string
required

Id of the scheduled message — the scheduled_id returned when it was created

Minimum string length: 1
Example:

"00000000-0000-0000-0000-000000000000"

Query Parameters

offset
integer | null

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.

Required range: x >= 0
Example:

0

limit
integer

Maximum number of records to return in one page. Defaults to 1000.

Required range: x >= 1
Example:

1000

start_time
string

Only runs at or after this time (ISO 8601).

Example:

"2026-01-01T00:00:00Z"

end_time
string

Only runs at or before this time (ISO 8601).

Example:

"2026-01-31T23:59:00Z"

is_success
enum<string>

Filter runs by outcome: 'true' (sent), 'false' (failed or skipped) or 'pending' (not resolved yet).

Available options:
true,
false,
pending
Example:

"false"

sort_order
enum<string>

Sort by run time: 'asc' or 'desc' (default).

Available options:
asc,
desc
Example:

"desc"

Response

Paginated list of runs, newest first

from
integer

1-based index of the first record in this page (offset + 1).

Example:

1

to
integer

1-based index of the last record in this page.

Example:

20

count
integer

Number of records in this page — the length of the occurrences array, not the total across all pages.

Example:

20

occurrences
object[]

The occurrences in this page.