TAtalkjs
Users

List users in an app

Lists all users that were ever created in your TalkJS application.

You can filter results based on whether the user is online or not, and by a timestamp for when the user was created.

get/v1/{appId}/users

Request

Path parameters

appIdstring required
Example:abcd1234

A unique identifier of your TalkJS app. You can find your app ID on the Settings page of your dashboard.

Query parameters

isOnlineboolean
Example:true

An optional parameter to filter results based on whether a user is online or not.

limitinteger
Example:25

An optional parameter to specify the number of results that should be returned.

startingAfterstring
Example:c10

An optional object ID that identifies a place in the record list, to allow you to paginate through a list of results.

By default, all records are sorted in descending order based on their createdAt property, which is a timestamp of a record's insertion date.

Response

Users listed successfully.

Example response

{
  "data": [
    {
      "id": "0123456789abc",
      "createdAt": 1525249255419,
      "name": "Alice",
      "role": "admin",
      "custom": {
        "country": "Bahrain"
      },
      "photoUrl": "https://talkjs.com/images/avatar-1.jpg",
      "locale": "ar",
      "welcomeMessage": "Hi there, how are you? :-)",
      "availabilityText": "We're usually online during office hours",
      "pushTokens": {
        "fcm:TOKEN_ID": true
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.