NAnationbuilder
Mailings

List all mailings in a nation

Changed on

Lists all mailings

get/api/v2/mailings

Request

  • Base URL
    https://yournation.nationbuilder.com
  • Auth
    HTTP bearer

Query parameters

page[number]string

Page number to list (starting at 1)

page[size]string

Number of results to display per page (default: 20, max: 100, min: 1)

Response

A page of matching mailings.

metaobject

Non-standard information about the document, such as requested statistics. Empty unless the endpoint has metadata to convey.

Example response

{
  "data": [
    {
      "id": "1",
      "type": "mailings",
      "attributes": {
        "broadcaster_id": "1",
        "canceled_at": "2019-10-26T10:00:00-04:00",
        "created_at": "2019-10-26T10:00:00-04:00",
        "custom_list_id": "1",
        "description": "Welcome EMail",
        "from": "Broadcaster Name",
        "name": "Welcome Email",
        "preheader": "You signed up!",
        "published_at": "2019-10-26T10:00:00-04:00",
        "queued_at": "2019-10-26T10:00:00-04:00",
        "send_at": "2019-10-26T10:00:00-04:00",
        "slug": "acme",
        "subject": "Welcome to our community",
        "tag_list": "new-signups",
        "updated_at": "2019-10-26T10:00:00-04:00"
      }
    }
  ],
  "links": {
    "self": "/articles?page[number]=2",
    "first": "/articles?page[number]=1",
    "last": "/articles?page[number]=5",
    "prev": "/articles?page[number]=1",
    "next": "/articles?page[number]=3"
  },
  "included": [
    {
      "id": "1"
    }
  ]
}

Changes

  • d5c88ca497acRevision changes
    • breaking

      for the query request parameter page[number], default value 1 was added

    • breaking

      for the query request parameter page[size], default value 20 was added

    • breaking

      the response's body 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

    • info

      added the new optional query request parameter extra_fields[mailings] to all path's operations

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status