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
skipintegerOptional

No. of results to skip.

limitintegerOptional

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

Header parameters
sessionTokenstringRequired

Session authentication token.

Body

Stream filtering parameters.

includeInactiveStreamsbooleanOptional

Whether to include inactive streams in the list of results.

Example: false
Responses
200

OK

application/json
post
POST /pod/v1/streams/list HTTP/1.1
Host: yourpodurl.symphony.com
sessionToken: text
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.

Last updated

Was this helpful?