Workplace from Meta is being discontinued – seamlessly migrate to Zoho Connect today. Learn More

Skip to main content

The purpose of this API is to get a user's feed in Zoho Connect.

Request URL:

https://connect.zoho.com/pulse/api/v1/userStreams

OAuth Scope:

zohopulse.userDetail.READ

Request Method:

GET

Mandatory Header:Header name: Authorization
Header Value: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52

Parameters

NameDescriptionRequired
scopeIDID of the network the user belongs to.Required
userIdThe user's zu ID or user ID. You can get this from the accounts profile.Required
partitionIdGroup ID of the userOptional
modifiedTimeFetch data till a specific time. Time should be in milliseconds eg)1521301549636Optional
limitSet a limit for the stream.Optional
commentLimit Set a limit on the number of comments.Optional

Sample URL

Copiedhttps://connect.zoho.com/pulse/api/v1/userStreams?userId=2060758&scopeID=929000000015001&partitionId=929000000295001&limit=3

Sample Response

Copied{
  "userStreams": {
    "streams": [
      {
        "id": "929000000855654",
        "sharedStream": {
          "id": "929000000836001",
          "title": "new logo ideas",
          "bestCommentId": "929000000836014",
          "streamUrl": "new-logo-ideas",
          "userDetails": {
            "zuid": "2060758",
            "id": "2060758",
            "name": "Patricia Boyle",
            "canFollow": "true",
            "type": "C"
          },
          "canDoBestComment": "true",
          "allowFooter": "true",
          "isApproved": "true",
          "isSpam": "false",
          "canAddTask": "true",
          "reason": {
            "items": {
              "*^$@_USERNAME_*^$@_2060758": {
                "zuid": "2060758",
                "id": "2060758",
                "name": "Patricia Boyle",
                "canFollow": "true"
              }
            },
            "msg": "*^$@_USERNAME_*^$@_2060758 has asked a question."
          },
          "type": "QUESTION",
          "content": [
            {
              "b": "start"
            },
            {
              "text": "new logo ideas"
            },
            {
              "b": "end"
            },
            {
              "text": "\n\n "
            }
          ],
          "time": "1517501789899",
          "streamModifiedTime": "1517501797445",
          "formatedTime": "01 Feb, 05:16 AM",
          "streamMentionData": [
            {
              "zuid": "2060758",
              "id": "2060758",
              "name": "Patricia Boyle",
              "type": "C",
              "emailId": "patriciab@zillum.com",
              "role": "MEMBER"
            }
          ]
        },
        "userDetails": {
          "zuid": "2060758",
          "id": "2060758",
          "name": "Patricia Boyle",
          "canFollow": "true",
          "type": "C"
        },
        "allowFooter": "true",
        "isApproved": "true",
        "isSpam": "false",
        "canAddTask": "true",
        "reason": {
          "items": {
            "*^$@_USERNAME_*^$@_2060758": {
              "zuid": "2060758",
              "id": "2060758",
              "name": "Patricia Boyle",
              "canFollow": "true"
            }
          },
          "msg": "*^$@_USERNAME_*^$@_2060758 has shared a post."
        },
        "type": "SHARED",
        "content": [
          {
            "text": "Stream shared"
          }
        ],
        "time": "1521526805467",
        "streamModifiedTime": "1521526805467",
        "formatedTime": "07:20 PM",
        "lastActivityTime": "0",
        "canEdit": "true",
        "canDelete": "true",
        "canLock": "true",
        "canFollow": "true",
        "canMove": "true",
        "comments": [],
        "url": "https://connect.zoho.com/portal/zillum/stream/929000000855654",
        "streamMentionData": [
          {
            "zuid": "2060758",
            "id": "2060758",
            "name": "Patricia Boyle",
            "type": "C",
            "emailId": "patriciab@zillum.com",
            "role": "MEMBER"
          }
        ]
      },
      {
        "id": "929000000855639",
        "userDetails": {
          "zuid": "2060758",
          "id": "2060758",
          "name": "Patricia Boyle",
          "canFollow": "true",
          "type": "C"
        },
        "allowFooter": "true",
        "isApproved": "true",
        "isSpam": "false",
        "canAddTask": "true",
        "reason": {
          "items": {
            "*^$@_USERNAME_*^$@_2060758": {
              "zuid": "2060758",
              "id": "2060758",
              "name": "Patricia Boyle",
              "canFollow": "true"
            }
          },
          "msg": "*^$@_USERNAME_*^$@_2060758 has started a poll."
        },
        "type": "POLL",
        "polls": {
          "voteDisplayType": "0",
          "allowmultiple": "true",
          "canShowResult": "true",
          "isVoted": "false",
          "options": [
            {
              "id": "929000000855646",
              "option": "Option1",
              "canDelete": "true"
            },
            {
              "id": "929000000855648",
              "option": "Option2",
              "canDelete": "true"
            }
          ]
        },
        "canAddPollOption": "true",
        "content": [
          {
            "text": "pollQuestion"
          }
        ],
        "time": "1521525195934",
        "streamModifiedTime": "1521525535794",
        "formatedTime": "06:53 PM",
        "lastActivityTime": "1521526488769",
        "likeCount": "1",
        "reactions": [
          {
            "type": "LIKE",
            "count": "1"
          }
        ],
        "likes": [
          {
            "zuid": "2060758",
            "name": "Patricia Boyle"
          }
        ],
        "commentCount": "1",
        "viewCount": "11",
        "isAuthorLiked": "true",
        "isCurrentUserLiked": "true",
        "reactionType": "LIKE",
        "canEdit": "true",
        "canDelete": "true",
        "canLock": "true",
        "canEditVote": "true",
        "canFollow": "true",
        "canMove": "true",
        "comments": [
          {
            "id": "929000000856603",
            "time": "1521525535794",
            "formatedTime": "06:58 PM",
            "isApproved": "true",
            "commentType": "COMMENT",
            "content": [
              {
                "text": "Hi team! Can you share the new logo designs that were completed yesterday?"
              }
            ],
            "userDetails": {
              "zuid": "2060758",
              "id": "2060758",
              "name": "Patricia Boyle",
              "canFollow": "true",
              "type": "C"
            },
            "canEdit": "true",
            "canDelete": "true",
            "isSpam": "false"
          }
        ],
        "url": "https://connect.zoho.com/portal/zillum/stream/929000000855639",
        "streamMentionData": [
          {
            "zuid": "2060758",
            "id": "2060758",
            "name": "Patricia Boyle",
            "type": "C",
            "emailId": "patriciab@zillum.com",
            "role": "MEMBER"
          }
        ]
      },
      {
        "id": "929000000855628",
        "userDetails": {
          "zuid": "2060758",
          "id": "2060758",
          "name": "Patricia Boyle",
          "canFollow": "true",
          "type": "C"
        },
        "allowFooter": "true",
        "isApproved": "true",
        "isSpam": "false",
        "canAddTask": "true",
        "reason": {
          "items": {
            "*^$@_USERNAME_*^$@_2060758": {
              "zuid": "2060758",
              "id": "2060758",
              "name": "Patricia Boyle",
              "canFollow": "true"
            }
          },
          "msg": "*^$@_USERNAME_*^$@_2060758 has started a conversation."
        },
        "type": "STATUS",
        "content": [
          {
            "text": "Content updated"
          }
        ],
        "time": "1521525017127",
        "streamModifiedTime": "1521525017127",
        "formatedTime": "06:50 PM",
        "lastActivityTime": "1521525076892",
        "viewCount": "1",
        "canEdit": "true",
        "canDelete": "true",
        "canLock": "true",
        "canFollow": "true",
        "canMove": "true",
        "comments": [],
        "url": "https://connect.zoho.com/portal/zillum/stream/929000000855628",
        "streamMentionData": [
          {
            "zuid": "2060758",
            "id": "2060758",
            "name": "Patricia Boyle",
            "type": "C",
            "emailId": "patriciab@zillum.com",
            "role": "MEMBER"
          }
        ]
      }
    ],
    "modifiedTime": "1516267465347"
  }
}

Show full

Show less