Skip to main content
GET
List online contacts

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Query Parameters

page
integer
default:1

The page parameter

Response

Success

meta
object

How many contacts are online, and the current page.

payload
object[]

The contacts with a live presence.