List Subscribers

Name Description
HTTP Method GET
URL https://api.newsweaver.com/v2/{account code}/subscribers
Query Parameters Yes
Request representation N/A
Response representation Subscriber List
Success Response Code 200 Ok
Name Allowed Values Description Default
ext_id Text Filter the list by given subscriber External ID N/A
status active
opt_out
inactive
all
Filter the list to subscribers with the given status active
permission [name of a permission] Restrict to subscribers associated with this permission N/A
tags [tag name or tag expression] Only include subscribers matching the given tag expression N/A
search [saved search name] Only include subscribers matching the named saved search N/A
added_from Date Only include subscribers added since this date N/A
added_to Date Only include subscribers added before this date N/A
fields [comma separated list of custom fields and field names] Used to restrict the size of the XML returned by omitting unnecessary fields All custom fields, and status email date_created source mail_format salutation first_name middle_name surname company position_company phone_number fax_number address_1 address_2 address_3 city postal_code county_state country
order_asc status
email
date_created
source
mail_format
first_name
middle_name
surname
company
position_company
city postal_code county_state country
Sort the list in ascending order by the given field N/A
order_desc status
email
date_created
source
mail_format
first_name
middle_name
surname
company
position_company
city
postal_code
county_state
country
Sort the list in descending order by the given field N/A

Errors

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

Other notes:

  • Using order_asc and order_desc together is undefined.
  • You cannot sort by multiple fields.
  • Tag expressions are tags names separated by pipes or semicolons. Pipes indicate OR, semicolons mean AND. It is not possible to mix both delimiters in a single expression. Tag names that themselves contain pipes or semicolons need to be escaped using a backslash.
Example Parameter Meaning
?tags=Some%20Tag Subscribers with Some Tag
?tags=Tag_A|Tag_B|Tag_C Subscribers with any of Tag_A or Tag_B or Tag_C
?tags=Tag_1;Tag_2;Tag_3 Subscribers with all of Tag_1 and Tag_2 and Tag_3
?tags=Odd;Tag|Name Subscribers with tag Odd;Tag|Name
?tags=One|Two;Three Not allowed, cannot mix ; and | together

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

<subscribers total="2" uri="https://api.newsweaver.com/v2/example-account/subscribers">
    <itemsPerPage>1000</itemsPerPage>
    <startIndex>0</startIndex>
    <totalResults>2</totalResults>
    <subscriber date_modified="2011-09-07T15:06:02Z" uri="https://api.newsweaver.com/v2/example-account/subscriber/1hkmrwl75za">
        <status>ACTIVE</status>
        <email>bob.robertson@example.com</email>
        <external_id>11343247</external_id>
    </subscriber>
    <subscriber date_modified="2011-06-01T10:30:29Z" uri="https://api.newsweaver.com/v2/example-account/subscriber/dldps01yfvz">
        <status>ACTIVE</status>
        <email>joe.bloggs@example.com</email>
        <external_id>24574791</external_id>
    </subscriber>
</subscribers>

results matching ""

    No results matching ""