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

chat_type
string

Type of chat.

Possible values - group, individual, business

label
string

The label_id assigned to the chat on Periskope.

e.g label-XXXXXXX

Response

200 - application/json
chats
object[]

Refer to the Chat object to find more details about the chat object.

count
number
to
number
from
number