List chats

This method lists all chats

Headers

X-API-Token

Parameters

`statuses`	Array
`status`	String
`users`	Array
`visitors`	Array
`sort_by`	String
`order`	String
`limit`	Integer

The request output will be shown here...

URL

https://api.natterly.com/api/v1/chats/list

Access

Must be authenticated as a user. If not authorised, a MustBeAuthenticated error will be returned.

Parameters

Parameter	Type	Default
statuses The statuses to return	Array	null
status Filter based on active/closed chats (cannot be used with 'statuses' param)	String	null
users Filter based on the assigned user for a chat	Array	null
visitors Filter based on the visitor for a chat	Array	null
sort_by What should be ordered by? (last_message, creation)	String	last_message
order Which direction? (asc or desc)	String	asc
limit How many chats should be returned?	Integer	null

Errors

There are no action-specific errors which can be raised.

Response Data

This action will return an array of chat structures.

You'll receive all attributes for this structure (basic and extended attributes). You'll receive expansions for department, user, visitor, session_id, site, last_message.