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

chat_id
string
required

Unique id of the chat. For 1-1 chats, country code + number optionally suffixed with @c.us (e.g. 922222222222@c.us — the suffix is added automatically when omitted); for groups, the id ending with @g.us.

Minimum string length: 1
Example:

"120363000000000000@g.us"

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 log entries at or after this time (ISO 8601).

Example:

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

end_time
string

Only log entries at or before this time (ISO 8601).

Example:

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

performed_by
string

One or more actors, comma-separated — member emails or "api".

Example:

"user@example.com"

action
string

One or more actions, comma-separated, e.g. 'NAME_CHANGED', 'IMAGE_CHANGED', 'ASSIGNEE_CHANGED', 'LABEL_CHANGED', 'CUSTOM_PROPERTY_CHANGED', 'CHAT_ARCHIVED', 'CHAT_UNARCHIVED'

Example:

"STATUS_CHANGED,ASSIGNEE_CHANGED"

sort_order
enum<string>

Sort by timestamp: 'asc' or 'desc' (default).

Available options:
asc,
desc
Example:

"desc"

Response

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

Example:

20

logs
object[]

The logs in this page.