Get Signups

Overview

The getSignups operation will return a list of newsletter and closed user group signups.

Request

Element	Type	Description
siteIDList	Array	An optional list of property IDs for which accounts should be returned. If provided, this must be a subset of properties that are enabled for your API. Alternatively, exclude this attribute from the request to get mapping info for every property enabled for your API.
afterDate	String	Providing this will filter results to only include accounts modified after this date.

Sample

{
    "userAuth": {
        "username": "username",
        "password": "password"
    },
    "operation": "getSignups",
    "siteIDList": [
        1853
    ],
    "afterDate": "2023-01-01"
}

Response

Element				Type	Description
siteList				Array	The siteList array will contain an entry for each site as requested in the siteIDList section of the request
	siteID			Integer	The internal siteID of the property in the IBE.
	primaryName			String	Property name.
	newsletterList			Array	A list of newsletter signups for this siteID.
		email		String	The email address used to sign up to receive newsletters.
		status			The status of the signup.
		dtSignedUp			The date the signup was first created.
		dtModified			The date the signup was last modified.
		name			Details of the name of the person that signed up.
			title		Title of the person that signed up.
			first		First name of the person that signed up.
			last		Last name of the person that signed up.
	closedUserGroupList				A list of closed user group signups.
		email			The email address used to sign up to the closed user group.
		dtCreated			The date the signup was created.
		dtLastSeen			The last date this signup was used to access closed user group rates.

Sample

{
  "siteList": [
    {
      "siteID": 1853,
      "primaryName": "TestHotel Mahony",
      "newsletterList": [
        {
          "email": "martin.mahony@avvio.com",
          "status": "active",
          "dtSignuedUp": "2023-03-28 11:26:29",
          "name": {
            "title": "Mr.",
            "first": "Test",
            "last": "Testerson"
          }
        },
        {
          "email": "martin@avvio.com",
          "status": "active",
          "dtSignuedUp": "2023-07-24 08:41:50",
          "name": {
            "title": "Mr",
            "first": "Martin",
            "last": "Grogan"
          }
        },
        {
          "email": "martin.mahony@shrgroup.com",
          "status": "active",
          "dtSignuedUp": "2023-07-26 12:29:12",
          "name": {
            "title": "Mr",
            "first": "Maverick",
            "last": "Test"
          }
        }
      ],
      "closedUserGroupList": [
        {
          "email": "martin.mahony@avvio.com",
          "dtCreated": "2023-03-28 13:58:04",
          "dtLastSeen": "2023-03-28 13:58:04"
        }
      ]
    }
  ]
}