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.

Headers

x-phone
string

Optional. Scope results to a single phone: country code + number without symbols or spaces (e.g. 911111111111), or a phone_id (phone-xxxxxxxxxxxx). Omit to return data across all phones the API token can access.

Example:

"919876543210"

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. Cannot exceed 2000. Defaults to 1000.

Required range: 1 <= x <= 2000
Example:

1000

start_time
string

Only return records at or after this time. Accepts ISO 8601 (e.g. 2026-01-01T00:00:00Z) and common date formats (YYYY-MM-DD, YYYY-MM-DD HH:mm, DD/MM/YYYY). Epoch timestamps are not supported. Compared at minute precision.

Example:

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

end_time
string

Only return records at or before this time. Accepts ISO 8601 (e.g. 2026-01-01T00:00:00Z) and common date formats (YYYY-MM-DD, YYYY-MM-DD HH:mm, DD/MM/YYYY). Epoch timestamps are not supported. Compared at minute precision.

Example:

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

Response

Paginated list of messages, 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 messages array, not the total across all pages.

Example:

20

start_time
string

Echo of the start_time filter, present only when it was sent.

Example:

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

end_time
string

Echo of the end_time filter, present only when it was sent.

messages
object[]

The messages in this page.