Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your apiKey generated in Periskope API settings.

Headers

x-phone
string
required

Organisation phone number(with country code) and without any spaces or special characters.

e.g. 9190043XXXXX

Query Parameters

offset
integer

Starting index of the list sorted based on timestamp

Default - 0

limit
number

Number of objects per request after offset.

Maximum - 2000, Default - 1000

Response

200 - application/json
custom_properties
object[]

A list of all custom properties added to any chat, along with a total count value.

Refer to the Custom Property object to find more details about chat custom proerties.

count
integer