GET
/
api
/
v1
/
newsletters
{
  "hydra:member": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "uuid": "<string>",
      "name": "<string>",
      "subject": "<string>",
      "owner": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "firstName": "<string>",
        "lastName": "<string>",
        "fullName": "<string>"
      },
      "html": "<string>",
      "design": [
        "<string>"
      ],
      "htmlRaw": "<string>",
      "cssRaw": "<string>",
      "clicks": [
        "<string>"
      ],
      "unit": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>"
      },
      "tenant": "https://example.com/",
      "localCenter": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>"
      },
      "isGeneral": true,
      "isContacts": true,
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateSent": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "recipients": 123,
      "rateSent": 123,
      "rateOpen": 123,
      "rateClick": 123,
      "rateBounced": 123,
      "rateCompliant": 123,
      "rateUnsubscribe": 123,
      "event": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "uuid": "<string>",
        "name": "<string>",
        "numberOfParticipants": 123,
        "isOnline": true,
        "settings": {
          "tenantLogo": true,
          "showTitle": true,
          "colorSelection": null,
          "colorButton": null,
          "disableSubscribe": false,
          "disableRegister": true,
          "lightThemeOnly": false,
          "isThankYouSingular": false,
          "fieldName": true,
          "fieldEmail": true,
          "fieldPhone": false,
          "fieldOrganisation": false,
          "fieldRole": false,
          "fieldTown": false,
          "fieldLinkedin": false,
          "fieldX": false,
          "fieldInstagram": false
        }
      },
      "sendToEverybody": true,
      "isPublic": true,
      "slugGo": "<string>",
      "publicPreviewLogo": "<string>",
      "userList": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>"
      }
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Query Parameters

page
integer
default:1

The collection page number

pagination
boolean

Enable or disable pagination

order[dateCreated]
enum<string>
default:asc
Available options:
asc,
desc

Response

200
application/ld+json

Newsletter collection

The response is of type object.