REST API

REST API

Legacy Poppulo platform REST API

List Permissions

Overview

NameDescription
HTTP MethodGET
URLhttps://api.newsweaver.com/v2/{account code}/permissions
Query ParametersNo
Request representationN/A
Response representationPermission List
Success Response Code200 Ok

Errors

  • 403 - Forbidden if API user doesn't have READ access to EMAIL_PERMISSIONS
  • Common errors (user/account authentication errors, API usage limit errors)

Example: GET https://api.newsweaver.com/v2/example-account/permissions

<permissions total="2" uri="https://api.newsweaver.com/v2/example-account/permissions">
    <itemsPerPage>1000</itemsPerPage>
    <startIndex>0</startIndex>
    <totalResults>2</totalResults>
    <permission uri="https://api.newsweaver.com/v2/example-account/permission/Newsletter">
        <name>Newsletter</name>
    </permission>
    <permission uri="https://api.newsweaver.com/v2/example-account/permission/Flyer">
        <name>Flyer</name>
    </permission>
</permissions>