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 records to return in one page, up to 2000. Defaults to 1000.

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

1000

type
string

One or more task kinds, comma-separated: 'todo', 'chat', 'message', 'ticket'.

Example:

"todo,chat"

status
string

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

Example:

"open,inprogress"

priority
string

One or more priorities, comma-separated: 1 (low), 2 (medium), 3 (high).

Example:

"2,3"

assignee
string

One or more assignee member emails, comma-separated.

Example:

"user@example.com"

created_by
string

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

Example:

"user@example.com"

start_time
string

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

Example:

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

end_time
string

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

Example:

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

due_date_start
string

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

Example:

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

due_date_end
string

Only tasks 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) or 'due_date'.

Available options:
created_at,
due_date
Example:

"due_date"

sort_order
enum<string>

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

Available options:
asc,
desc
Example:

"desc"

q
string

Case-insensitive substring search on the task title.

Example:

"hello"

Response

Paginated list of tasks

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

Example:

20

tasks
object[]

The tasks in this page.