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 tickets to return in one page (up to 2000). Defaults to 1000.

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

1000

raised_by
string

One or more raiser member emails (or "api"), comma-separated.

Example:

"user@example.com"

assignee
string

One or more assignee member emails, comma-separated.

Example:

"user@example.com"

assigned_by
string

One or more assigner member emails, comma-separated.

Example:

"user@example.com"

status
string

One or more statuses, comma-separated: 'open', 'inprogress', 'closed', 'archived'.

Example:

"open,inprogress"

priority
string

One or more priorities, comma-separated: 1 (low) to 4 (urgent).

Example:

"3,4"

priority_min
integer

Only tickets with priority at or above this value (1-4).

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

2

priority_max
integer

Only tickets with priority at or below this value (1-4).

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

4

label
string

One or more labels, comma-separated — label names (matched exactly) or label_ids. Tickets carrying ANY of them match.

Example:

"urgent,billing"

start_time
string

Only tickets created at or after this time (ISO 8601).

Example:

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

end_time
string

Only tickets created at or before this time (ISO 8601).

Example:

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

due_date_start
string

Only tickets due at or after this time (ISO 8601).

Example:

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

due_date_end
string

Only tickets due at or before this time (ISO 8601).

Example:

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

sort_by
enum<string>

Field to sort by: 'created_at' (default), 'due_date' or 'priority'.

Available options:
created_at,
due_date,
priority
Example:

"priority"

sort_order
enum<string>

Sort direction: 'asc' or 'desc' (default).

Available options:
asc,
desc
Example:

"desc"

q
string

Case-insensitive substring search on the ticket subject and ticket_id.

Example:

"hello"

Response

Paginated list of tickets

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 tickets array, not the total across all pages.

Example:

20

tickets
object[]

The tickets in this page.