Search Rooms

Search for rooms, querying name, description, and specified keywords.

Search rooms according to the specified criteria.

post

/v3/room/search

Query parameters

skipinteger

No. of results to skip.

limitinteger

Max no. of results to return. If no value is provided, 50 is the default. Must be a positive integer and must not exceed 100

Header parameters

sessionTokenstringrequired

Session authentication token.

Body

querystringrequired

The search query. Matches the room name and description.

Example: automobile

activeboolean

Restrict the search to active/inactive rooms. If unspecified, search all rooms.

Example: true

privateboolean

Restrict the search to private rooms. If unspecified, search all rooms.

Example: true

ownerobject

creatorobject

memberobject

sortOrderstring · enum

Sort algorithm to be used. Supports two values: "BASIC" (legacy algorithm) and "RELEVANCE" (enhanced algorithm).

Example: RELEVANCE

Options: BASIC, RELEVANCE

labelsstring[]

A list of room tag labels whose values will be queried.

Example: ["industry"]

subTypestring

Restrict the search to the specific room subtype. Valid values are: EMAIL

Example: EMAIL

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'yourpodURL.symphony.com/pod/v3/room/search' \
  --header 'sessionToken: text' \
  --header 'Content-Type: application/json' \
  --data '{"subType":"EMAIL"}'

200

400

401

403

500

200

{
  "count": 2,
  "skip": 0,
  "limit": 10,
  "facetedMatchCount": [
    {
      "facet": "industry",
      "count": 1
    }
  ],
  "query": {
    "query": "automobile",
    "active": true,
    "labels": [
      "industry"
    ],
    "creator": {
      "id": 7696581411197
    }
  },
  "rooms": [
    {
      "roomAttributes": {
        "name": "Automobile Industry Room",
        "description": "Room to discuss car companies",
        "membersCanInvite": true,
        "readOnly": false,
        "copyProtected": false,
        "crossPod": false,
        "viewHistory": false,
        "public": false,
        "multiLateralRoom": false
      },
      "roomSystemInfo": {
        "id": "tzwvAZIdDMG3ZPRxv+xsgH///qr+JJkWdA==",
        "creationDate": 1464615003895,
        "createdByUserId": 7696581411197,
        "active": true
      }
    },
    {
      "roomSystemInfo": {
        "id": "o6UkQ1TEmU0Tf/DHUlZrCH///qr+JQowdA==",
        "creationDate": 1464614974947,
        "createdByUserId": 7696581411197,
        "active": true
      },
      "roomAttributes": {
        "name": "Tesla Room",
        "description": "Discussions on TSLA",
        "membersCanInvite": true,
        "readOnly": false,
        "copyProtected": false,
        "crossPod": false,
        "viewHistory": false,
        "public": false,
        "multiLateralRoom": false,
        "keywords": [
          {
            "key": "industry",
            "value": "automobile"
          }
        ]
      }
    }
  ]
}

OK

📘 Room Search Scope

Room search is performed on the set of:

• All rooms that the calling user is a member of (private or public, active or inactive)

• All active public rooms

• Private rooms that the calling user is not a member of, where the room is set to be visible in search, is active and the room does not contain any user with whom the calling user has an information barrier

Note: visit Overview for an overview of streams.

🚧 Room Description Search

The description is only searched for hashtags and cashtags containing the search query. For example if query were foo and the description of a room contained "foo", this room would not be returned in the search results; however, if the description contained "#foo", this room would be returned in the search results.