Skip to main content
GET
/
api
/
v1
/
presence
/
users
/
list
Get presence state of provided user list
curl --request GET \
  --url https://apix.us.amity.co/api/v1/presence/users/list \
  --header 'Authorization: Bearer <token>'
{
  "presences": [
    {
      "userId": "<string>",
      "lastHeartbeat": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
userIds
string[]
required

A list of user ID

Maximum array length: 220
Maximum string length: 300
Example:
["yama69", "yama420"]

Response

Get user presence list response

List of user presence

​
presences
object[]