REST API

REST API

Legacy Poppulo platform REST API

List Publications

Overview

NameDescription
HTTP MethodGET
URLhttps://api.newsweaver.com/v2/{account code}/publications
Query ParametersYes
Request representationN/A
Response representationPublication List
Success Response Code200 Ok
NameAllowed ValuesDescriptionDefault
category1newsletter
flyer
all		Filter the list by publication typeall
permission[name of a permission]Restrict to publications associated with this permissionN/A
fields[comma separated list of field names]Used to restrict the size of the XML returned by omitting unnecessary fieldsname
description
order_asccode
name		Sort the list in ascending order by the given fieldN/A
order_desccode
name		Sort the list in descending order by the given fieldN/A

Errors

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

Other notes:

  • This list is filtered based on what publications the API user can see. Ensure your API user has a role in each relevant publication.
  • Using order_asc and order_desc together is undefined.
  • You cannot sort by multiple fields.

Example: GET https://api.newsweaver.com/v2/sample-account/publications

<publications total="2" uri="https://api.newsweaver.com/v2/example-account/publications">
    <itemsPerPage>1000</itemsPerPage>
    <startIndex>0</startIndex>
    <totalResults>2</totalResults>
    <publication code="newsletter" uri="https://api.newsweaver.com/v2/example-account/publication/63795">
        <name>Newsletter</name>
        <description>This is a Newsletter.</description>
    </publication>
    <publication code="seasonalcard" uri="https://api.newsweaver.com/v2/example-account/publication/77555">
        <name>Seasonal Card</name>
    </publication>
</publications>

Footnotes

  1. This functionality is deprecated and may not be available to you. ↩