Skip to main content
Node.js
import { PeriskopeApi } from '@periskope/periskope-client';

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
  phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});

async function getAllCustomProperties() {
  const response = await client.property.getAll({
    type: 'ticket'
  });

  console.log(response);
}

getAllCustomProperties();
{
  "success": true,
  "data": [
    {
      "property_id": "property-a1b2c3",
      "property_name": "Workspace",
      "type": "ticket",
      "kind": "dropdown",
      "mandatory": false,
      "section_id": "3f8b6c1e-8f2a-4b6e-9c3d-2a1f0e9d8c7b",
      "section_name": "Issue Details",
      "options": [
        {
          "id": "1712345678901",
          "label": "Acme Corp"
        }
      ],
      "created_at": "2026-07-06T10:00:00.000Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

type
enum<string>

Fetch only chat or only ticket properties. Omit to fetch both

Available options:
chat,
ticket

Response

200 OK

success
boolean
Example:

true

data
object[]