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

property_id
string
required

The property_id (property-xxxxxxxxxxxxxxxx) or the name (case-insensitive) of the custom property. Prefer the property_id — a name that exists as both a chat and a ticket property is ambiguous without the type query parameter.

Minimum string length: 1
Example:

"property-aaaaaaaaaaaa"

Query Parameters

type
enum<string>

Resolves the chat or the ticket property when property_id is a name that exists as both. Not needed when passing a property_id, or when the name only exists under one type.

Available options:
chat,
ticket
Example:

"ticket"

Response

The matched property (or array of matches, see data)

The matched property. An array of every match when property_id is a name that exists as both a chat and a ticket property and no type query parameter was passed.

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"