# List User Streams

## POST /v1/streams/list

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

```json
{"openapi":"3.1.1","info":{"title":"Pod API","version":"20.17.1"},"servers":[{"url":"http://yourpodURL.symphony.com/pod"}],"paths":{"/v1/streams/list":{"post":{"summary":"Retrieve a list of all streams of which the requesting user is a member,\nsorted by creation date (ascending).\n","parameters":[{"schema":{"type":"string"},"name":"sessionToken","description":"Session authentication token.","in":"header","required":true},{"schema":{"type":"integer"},"name":"skip","description":"No. of results to skip.\n","in":"query"},{"schema":{"type":"integer"},"name":"limit","description":"Max no. of results to return. If no value is provided, 50 is the default.\n","in":"query"}],"tags":["Streams"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StreamList"}}}},"204":{"description":"Stream not found."},"400":{"description":"Client error, see response body for further details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Invalid session token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden: Caller lacks necessary entitlement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Server error, see response body for further details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StreamFilter"}}},"description":"Stream filtering criteria."}}}},"components":{"schemas":{"StreamList":{"description":"A list of streams of which the requesting user is a member.","type":"array","items":{"$ref":"#/components/schemas/StreamAttributes"}},"StreamAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The stream ID."},"crossPod":{"type":"boolean","description":"If true, this is a cross-pod stream."},"active":{"type":"boolean","description":"If true, this stream is active."},"streamType":{"$ref":"#/components/schemas/StreamType"},"streamAttributes":{"$ref":"#/components/schemas/ConversationSpecificStreamAttributes"},"roomAttributes":{"$ref":"#/components/schemas/RoomSpecificStreamAttributes"}}},"StreamType":{"type":"object","properties":{"type":{"type":"string","enum":["IM","MIM","ROOM","POST"]}}},"ConversationSpecificStreamAttributes":{"type":"object","properties":{"members":{"$ref":"#/components/schemas/UserIdList"}}},"UserIdList":{"type":"array","items":{"type":"integer","format":"int64"}},"RoomSpecificStreamAttributes":{"type":"object","properties":{"name":{"type":"string","description":"Room name."}}},"Error":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"}}},"StreamFilter":{"description":"Stream filtering parameters.","properties":{"streamTypes":{"description":"Types of streams to search for.","type":"array","items":{"$ref":"#/components/schemas/StreamType"}},"includeInactiveStreams":{"description":"Whether to include inactive streams in the list of results.","type":"boolean"}}}}}}
```

### Request Example

```bash
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).

```json
{
	"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](https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/overview-of-streams).