SEsendfox
Lists

Get contacts in a list

Changed on

Returns every contact on the list. This is membership, not subscription: someone who unsubscribed from the list is still a member and is still returned, so that an integration mirroring this endpoint can tell "removed from the list" apart from "asked to stop receiving it". Each row carries list_unsubscribed_at to tell them apart. Pass status to narrow it.

get/lists/{list_id}/contacts

Request

  • Base URL
    https://api.sendfox.com
  • Auth
    OAuth 2
    Authorization codehttps://sendfox.com/oauth/authorize
    Token URLhttps://sendfox.com/oauth/token

Query parameters

querystring

Search query for filtering contacts

status'subscribed' | 'unsubscribed'

Optional. Omit for every member, which is the long-standing behaviour of this endpoint. subscribed returns members who can still be mailed from this list; unsubscribed returns members who have stopped it, whether by leaving this list or by unsubscribing from the account. The two do not sum to the unfiltered total, because an address flagged invalid is in neither. A hard bounce counts as unsubscribed, since bouncing sets the account-wide flag. They match the Subscribed and Unsubscribed figures shown on the Lists page exactly. An unrecognised value is rejected with 400 rather than ignored.

Response

Successful response

current_pageinteger
totalinteger
per_pageinteger

Changes

  • ae5d5ba1d502Revision changes
    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the non-success response with the status

    • info

      added subschema #2 to the / response property allOf list for the response status

  • 1c85e046fea0Revision changes
    • info

      added the new optional query request parameter status

    • info

      added the non-success response with the status