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.

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 entries to return in one page. Defaults to 1000; cannot exceed 2000.

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

1000

type
enum<string>

Return only entries of one kind: 'faq', 'document' (chunks of uploaded PDFs) or 'self-learned'. Omit to return every entry.

Available options:
faq,
document,
self-learned
Example:

"faq"

Response

Paginated list of knowledge-base entries

data
object[]

The knowledge-base entries in this page, newest first. Null when no entries are returned.

count
integer

Exact total number of entries across all pages (not this page size). Null when unavailable.

Example:

135