Skip to main content
GET
/
api
/
{session}
/
chats
/
overview
Get conversations overview
curl --request GET \
  --url https://{host}/api/{session}/chats/overview \
  --header 'apikey: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "picture": "<string>",
    "lastMessage": {},
    "_chat": {}
  }
]

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

​
session
string
required

The session name (instanceName) to get conversations

Query Parameters

​
limit
number
default:20
​
offset
number
​
ids
string[]

Filter by conversation IDs

Response

200 - application/json
​
id
string
required
​
name
string | null
required
​
picture
string | null
required
​
lastMessage
object
required
​
_chat
object
required