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  the details of a single post in Zoho Connect

Request URL:

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

OAuth Scope:

zohopulse.feedList.READ

Request Method:

GET

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

Parameters

NameDescriptionRequired

scopeID 

Network in which the post was made. You can get the ID from the network list API.

Required

streamId

Get the post by id.

Required

streamUrl

You can also fetch the post by URL.

Optional

commentIndex

Start an index for comments. The default will be 0.

Optional

commentLimit

Set a limit on the number of comments. The default will be 20.

Optional

isThread

Normal view or threaded view(the replies will be nested into comments json). Set this as either true or false.

Optional

needAllComments 

Show all comments or not. You can set this as either true or false depending on whether you need to view all the comments.

Optional

 

Sample URL

Copiedhttps://connect.zoho.com/pulse/api/v1/singleStream?scopeID=929000000015001&streamId=929000000699022&commentLimit=10&isThread=true

Sample Response

Copied{
  "singleStream": {
    "stream": {
      "id": "929000000699022",
      "isThread": "true",
      "userDetails": {
        "zuid": "2060758",
        "id": "2060758",
        "name": "Patricia Boyle",
        "canFollow": "true",
        "type": "C"
      },
      "relatedTasks": [
        {
          "title": [
            {
              "text": "Connect Translation"
            }
          ],
          "taskId": "929000000699037",
          "streamId": "929000000699039",
          "priority": "None",
          "url": "https://connect.zoho.com/portal/zillum/task/929000000699039"
        }
      ],
      "partition": {
        "id": "929000000015031",
        "name": "Company Wall",
        "partitionUrl": "default",
        "url": "default",
        "status": "ACTIVE",
        "isAdmin": "true",
        "type": "DEFAULT",
        "typeOrd": "0",
        "isUserFollow": "false"
      },
      "allowFooter": "true",
      "isApproved": "true",
      "isSpam": "false",
      "canAddTask": "true",
      "reason": {
        "items": {
          "*^$@_PARTITION_*^$@": {
            "id": "929000000015031",
            "name": "Company Wall",
            "partitionUrl": "default",
            "url": "default",
            "status": "ACTIVE",
            "isAdmin": "true",
            "type": "DEFAULT",
            "typeOrd": "0",
            "isUserFollow": "false"
          },
          "*^$@_USERNAME_*^$@_2060758": {
            "zuid": "2060758",
            "id": "2060758",
            "name": "Patricia Boyle",
            "canFollow": "true"
          }
        },
        "msg": "*^$@_USERNAME_*^$@_2060758 has posted in *^$@_PARTITION_*^$@."
      },
      "type": "STATUS",
      "content": [
        {
          "b": "start"
        },
        {
          "text": "Connect Translation"
        },
        {
          "b": "end"
        },
        {
          "text": "\n\n"
        },
        {
          "name": "Eduardo Vargas",
          "zuid": "2060557"
        },
        {
          "text": " can you help me with the translation of the below block. \n"
        },
        {
          "bq": "start"
        },
        {
          "text": "Zoho Connect is a team collaboration software that brings people and the resources they need to one place, making it easier to get work done."
        },
        {
          "bq": "end"
        }
      ],
      "time": "1502893119864",
      "streamModifiedTime": "1521525775191",
      "formatedTime": "16 Aug 2017",
      "lastActivityTime": "1521525775288",
      "commentCount": "3",
      "viewCount": "9",
      "canEdit": "true",
      "canDelete": "true",
      "canLock": "true",
      "canFollow": "true",
      "canMove": "true",
      "qualifiedUser": "true",
      "tags": [],
      "comments": [
        {
          "id": "929000000699033",
          "time": "1502893143169",
          "formatedTime": "16 Aug 2017",
          "isApproved": "true",
          "commentType": "COMMENT",
          "content": [
            {
              "text": "Hey I can help you."
            }
          ],
          "userDetails": {
            "zuid": "2060758",
            "id": "2060758",
            "name": "Patricia Boyle",
            "canFollow": "true",
            "type": "C"
          },
          "canEdit": "true",
          "canDelete": "true",
          "isSpam": "false"
        },
        {
          "id": "929000000699104",
          "time": "1502893585042",
          "formatedTime": "16 Aug 2017",
          "isApproved": "true",
          "commentType": "COMMENT",
          "content": [
            {
              "name": "Amritha Agrawal",
              "zuid": "2063270"
            },
            {
              "text": " can you please help?"
            }
          ],
          "userDetails": {
            "zuid": "2060758",
            "id": "2060758",
            "name": "Patricia Boyle",
            "canFollow": "true",
            "type": "C"
          },
          "canEdit": "true",
          "canDelete": "true",
          "isSpam": "false",
          "replies": [
            {
              "id": "929000000856615",
              "time": "1521525775191",
              "formatedTime": "07:02 PM",
              "isApproved": "true",
              "commentType": "COMMENT",
              "isReply": "true",
              "parentCommentId": "929000000699104",
              "pcUserDetails": {
                "zuid": "2060758",
                "id": "2060758",
                "name": "Patricia Boyle",
                "canFollow": "true",
                "type": "C"
              },
              "content": [
                {
                  "text": "Thank you"
                }
              ],
              "userDetails": {
                "zuid": "2060758",
                "id": "2060758",
                "name": "Patricia Boyle",
                "canFollow": "true",
                "type": "C"
              },
              "canEdit": "true",
              "canDelete": "true",
              "isSpam": "false"
            }
          ]
        }
      ],
      "modifiedTime": "1502893143169",
      "url": "https://connect.zoho.com/portal/zillum/stream/929000000699022",
      "mentionedUsers": [
        {
          "zuid": "2060557",
          "name": "Eduardo Vargas",
          "type": "C"
        },
        {
          "zuid": "2063270",
          "name": "Amritha Agrawal",
          "type": "C"
        }
      ],
      "streamParticipants": [
        {
          "zuid": "2060758",
          "name": "Patricia Boyle",
          "type": "C"
        }
      ],
      "streamMentionData": [
        {
          "zuid": "2060557",
          "id": "2060557",
          "name": "Eduardo Vargas",
          "canFollow": "true",
          "type": "C",
          "emailId": "eduardov@zillum.com",
          "role": "MEMBER"
        },
        {
          "zuid": "2060758",
          "id": "2060758",
          "name": "Patricia Boyle",
          "type": "C",
          "emailId": "patriciab@zillum.com",
          "role": "MEMBER"
        },
        {
          "zuid": "2063270",
          "id": "2063270",
          "name": "Amritha Agrawal",
          "canFollow": "true",
          "type": "C",
          "emailId": "igrawal@zillum.com",
          "role": "MEMBER"
        }
      ]
    }
  }
}

Show full

Show less