Get All Announcements API

To list all announcements using API.

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Request Parameters:

isStickyif true is given then all the sticky announcements are fetched; if false is given then all the announcements are fetched
*startIdxthe starting index to be given - 10 records from the given starting index will be fetched at a time ; starting index should be 1 or greater than 1 ( if isSticky is given then the param will fetch based on results from isSticky )
searchkeyword given is searched from the 10 records (from the given starting index); if param not given then no search is done

 Threshold Limit:  10 requests | Lock period: 5 minutes

Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.

Request

XMLJson
Copiedhttps://people.zoho.com/people/api/announcement/getAllAnnouncement?authtoken=<token>&startIdx=1&search=Program&isSticky=false
Copiedhttps://people.zoho.com/people/api/announcement/getAllAnnouncement?startIdx=1&search=Program&isSticky=false

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

XMLJson
Copied<response uri="/api/announcement/getAllAnnouncement">
    <status>0</status>
    <message>Success</message>
    <result>
        <resultData>
            <announcementList>
                <data>
                    <owner>3000000013255</owner>
                    <modifiedTime>1543209052900</modifiedTime>
                    <subject>Wellness Program!</subject>
                    <isCommentDisable>1</isCommentDisable>
                    <isNotify>1</isNotify>
                    <announcementId>3000000183011</announcementId>
                    <publishDate>1543209052899</publishDate>
                    <expireDate>-1</expireDate>
                    <message>Enjoy a week-long wellness program at all our office locations.</message>
                    <isActive>false</isActive>
                    <isSticky>1</isSticky>
                    <notifyOthersEmailIds>c.spalding@zylker.com,</notifyOthersEmailIds>
                </data>
                <data>
                    <owner>3000000013255</owner>
                    <modifiedTime>1542962837811</modifiedTime>
                    <subject>Wellness Program!</subject>
                    <isCommentDisable>0</isCommentDisable>
                    <isNotify>1</isNotify>
                    <announcementId>3000000166005</announcementId>
                    <publishDate>1542962837811</publishDate>
                    <expireDate>-1</expireDate>
                    <message>Enjoy a week-long wellness program at all our office locations.</message>
                    <isActive>true</isActive>
                    <isSticky>1</isSticky>
                    <notifyOthersEmailIds>c.spalding@zylker.com,</notifyOthersEmailIds>
                </data>
            </announcementList>
            <annLikeCnt>{"success":true,"statusIds":{"3000000171125":[true,1]},"commentIds":{}}
</annLikeCnt>
            <hasNext>true</hasNext>
            <commentsCnt>{"3000000183011":4}</commentsCnt>
        </resultData>
    </result>
</response>
Copied{
    "response": {
        "result": {
            "resultData": {
                "announcementList": [
                    {
                        "owner": "3000000013255",
                        "modifiedTime": "1543209052900",
                        "subject": "Wellness Program!",
                        "isCommentDisable": 1,
                        "isNotify": 1,
                        "announcementId": "3000000183011",
                        "publishDate": "1543209052899",
                        "expireDate": -1,
                        "message": "Enjoy a week-long wellness program at all our office locations.",
                        "isActive": false,
                        "isSticky": 1,
                        "notifyOthersEmailIds": "c.spalding@zylker.com,"
                    }
                ],
                "annLikeCnt": {
                    "success": true,
                    "statusIds": {
                        "3000000171125": [
                            true,
                            1
                        ]
                    },
                    "commentIds": {}
                },
                "hasNext": true,
                "commentsCnt": {
                    "3000000183011": 4
                }
            }
        },
        "message": "Success",
        "uri": "/api/announcement/getAllAnnouncement",
        "status": 0
    }
}