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

property_value_type
string

One or more value kinds, comma-separated: 'text', 'date', 'file', 'dropdown', 'picklist', 'dependent_dropdown'.

Example:

"dropdown,picklist"

created_by
string

One or more creator member emails, comma-separated.

Example:

"user@example.com"

start_time
string

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

Example:

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

end_time
string

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

Example:

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

sort_order
enum<string>

Sort by creation time: 'asc' or 'desc'. Omit to keep the workspace's configured ordering.

Available options:
asc,
desc
Example:

"desc"

q
string

Case-insensitive substring search on the property name.

Example:

"hello"

type
enum<string>

Return only chat or only ticket properties. Omit to return both.

Available options:
chat,
ticket
Example:

"ticket"

Response

All custom properties in the workspace

property_id
string

Unique id of the custom property (property-xxxxxxxxxxxxxxxx). Accepted wherever a property_id path parameter or property reference is expected.

Example:

"property-aaaaaaaaaaaa"

property_name
string

Name of the property. Unique within its type (case-insensitive) — the same name can exist once as a chat property and once as a ticket property.

Example:

"Workspace"

type
enum<string>

Whether the property applies to chats ('chat') or to tickets ('ticket')

Available options:
chat,
ticket
Example:

"ticket"

kind
string

Value kind of the property: 'text', 'date', 'file', 'dropdown' (single choice), 'picklist' (multiple choice) or 'dependent_dropdown' (dashboard-created only — cannot be created via the API)

Example:

"dropdown"

mandatory
boolean

Whether the property must be filled in. Always false for chat properties — only ticket properties can be mandatory.

Example:

false

section_id
string

Id of the section the property is placed under. null when the property is not in any section.

Example:

"00000000-0000-0000-0000-000000000000"

section_name
string

Name of the section the property is placed under. null when the property is not in any section.

Example:

"Issue Details"

options
object[]

Options of the property as {id, label} pairs. Present only for dropdown and picklist kinds — omitted for every other kind.

Example:
created_at
string

When the property was created, as an ISO 8601 timestamp

Example:

"2026-01-15T09:30:00.000Z"