List User Streams (Admin)

Returns a list of all the streams of which the specified user is a member, sorted by creation date (ascending - oldest to newest).

Released in 20.16.

Retrieve a list of all streams of which this user is a member, sorted by creation date (ascending). Since SBE 20.16.

post

/v1/admin/user/{uid}/streams/list

Path parameters
uidinteger · int64required

User ID as a decimal integer

Query parameters
skipinteger

No. of results to skip.

limitinteger

Max no. of results to return. If no value is provided, 50 is the default.

Header parameters
sessionTokenstringrequired

Session authentication token.

Body
includeInactiveStreamsboolean

Whether to include inactive streams in the list of results.

Example: false
streamTypesobject[]

Types of streams to search for.

Example: [{"type":"IM"},{"type":"ROOM"}]
Responses
curl -L \
  --request POST \
  --url 'yourpodURL.symphony.com/pod/v1/admin/user/{uid}/streams/list' \
  --header 'sessionToken: text' \
  --header 'Content-Type: application/json'
[
  {
    "id": "Jq6uPN4-uIop7lvjOkYdXX___nn9I0PHdA",
    "crossPod": false,
    "active": true,
    "streamType": {
      "type": "IM"
    },
    "streamAttributes": {
      "members": [
        9139690966401,
        9139691042211
      ]
    }
  },
  {
    "id": "iWyZBIOdQQzQj0tKOLRivX___qu6YeyZdA",
    "crossPod": false,
    "active": true,
    "streamType": {
      "type": "POST"
    },
    "streamAttributes": {
      "members": [
        7215545078229
      ]
    }
  }
]

🚧 Required Permissions

Only service users with the User Provisioning role can use this endpoint.

📘 Overview of streams

A stream is like a container for messages exchanged between two or more users via a given instant message (IM) or chat room. For more information, refer to Overview of streams.

Last updated

Was this helpful?