List User Streams

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

Retrieve a list of all streams of which the requesting user is a member, sorted by creation date (ascending).

post

Query parameters

skipanyOptional

No. of results to skip.

limitanyOptional

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

Header parameters

sessionTokenanyRequired

Session authentication token.

Body

Stream filtering parameters.

streamTypesobject[]Optional

Types of streams to search for.

Example: [{"type":"IM"},{"type":"ROOM"}]

includeInactiveStreamsbooleanOptional

Whether to include inactive streams in the list of results.

Example: false

Responses

application/json

object[]Optional

A list of streams of which the requesting user is a member.

application/json

application/json

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /pod/v1/streams/list HTTP/1.1
Host: yourpodURL.symphony.com
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "streamTypes": [
    {
      "type": "IM"
    },
    {
      "type": "ROOM"
    }
  ],
  "includeInactiveStreams": "false"
}

[
  {
    "id": "text",
    "crossPod": true,
    "active": true,
    "streamType": {
      "type": "ROOM"
    },
    "streamAttributes": {
      "members": [
        7215545058313,
        7215545078461
      ]
    },
    "roomAttributes": {
      "name": "text"
    }
  }
]

Request Example

curl -X POST \
https://acme.symphony.com/pod/v1/streams/list \
-H "sessionToken: SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{
	"streamTypes": [
  	{"type": "IM"},
    {"type": "ROOM"},
    {"type": "POST"}
  ],
  "includeInactiveStreams": true
}'

streamTypes

streamTypes: A list of stream types (defined as an object) that will be returned. Options are IM (1-1 instant messages), ROOM (rooms), POST (the user's wall).

{
	"streamTypes": [
    {"type": "IM"}, 
    {"type": "ROOM"}, 
    {"type": "POST"}
  ],
	"includeInactiveStreams": true
}

📘 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.