Customer

Get customer changes for date

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/DataExtract/Restaurant/{deploymentId}/{providerId}/CustomerChange/{changeDate}

Gets the changes to any customers for the specified date.

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Path parameters

deploymentIdinteger · int32Required

The Id of the deployment that the provider is in.

providerIdinteger · int32Required

The provider's Id.

changeDatestring · date-timeRequired

The date to get the changes for, in UTC.

Query parameters

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

Contains a change that was made to a customer. Null fields mean they have not been changed. If all the fields are null, it means that a property that is not currently being reported has been changed.

CustomerIdinteger · int32Optional

The Customer Id

ProviderIdinteger · int32Optional

The provider id the customer is associated with.

ModifiedByUserIdinteger · int32Optional

The internal ResDiary Id of the user who made the change.

ModifiedDateTimestring · date-timeOptional

The date and time the change was made in UTC.

EmailAddressstringOptional

The new email address

MobileNumberstringOptional

The new Mobile number

ReceiveGroupEmailMarketingbooleanOptional

The new group email opt-in setting

GroupEmailMarketingOptInDateTimestring · date-timeOptional

The new group email opt-in date

GroupEmailMarketingOptInTextstringOptional

The new group email opt-in text

ReceiveGroupSmsMarketingbooleanOptional

The new group sms opt-in setting

GroupSmsMarketingOptInDateTimestring · date-timeOptional

The new group sms opt-in date

GroupSmsMarketingOptInTextstringOptional

The new group sms opt-in text

ReceiveRestaurantEmailMarketingbooleanOptional

The new restaurant email opt-in setting

RestaurantEmailMarketingOptInDateTimestring · date-timeOptional

The new restaurant email opt-in date

RestaurantEmailMarketingOptInTextstringOptional

The new restaurant email opt-in text

ReceiveRestaurantSmsMarketingbooleanOptional

The new restaurant sms opt-in setting

RestaurantSmsMarketingOptInDateTimestring · date-timeOptional

The new restaurant sms opt-in date

RestaurantSmsMarketingOptInTextstringOptional

The new restaurant sms opt-in text

CustomerMarketingSourceIpAddressstringOptional

The new IP address of the latest recorded Marketing opt-in change that the request comes from.

DeletedbooleanOptional

The new deleted status

CommentsstringOptional

The new comments relating to the customer.

get

/api/ConsumerApi/v1/DataExtract/Restaurant/{deploymentId}/{providerId}/CustomerChange/{changeDate}

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/DataExtract/Restaurant/{deploymentId}/{providerId}/CustomerChange/{changeDate} HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "CustomerId": 1,
    "ProviderId": 2,
    "ModifiedByUserId": 3,
    "ModifiedDateTime": "2025-09-18T14:22:59",
    "EmailAddress": "sample string 5",
    "MobileNumber": "sample string 6",
    "ReceiveGroupEmailMarketing": true,
    "GroupEmailMarketingOptInDateTime": "2025-09-18T14:22:59",
    "GroupEmailMarketingOptInText": "sample string 7",
    "ReceiveGroupSmsMarketing": true,
    "GroupSmsMarketingOptInDateTime": "2025-09-18T14:22:59",
    "GroupSmsMarketingOptInText": "sample string 8",
    "ReceiveRestaurantEmailMarketing": true,
    "RestaurantEmailMarketingOptInDateTime": "2025-09-18T14:22:59",
    "RestaurantEmailMarketingOptInText": "sample string 9",
    "ReceiveRestaurantSmsMarketing": true,
    "RestaurantSmsMarketingOptInDateTime": "2025-09-18T14:22:59",
    "RestaurantSmsMarketingOptInText": "sample string 10",
    "CustomerMarketingSourceIpAddress": "sample string 11",
    "Deleted": true,
    "Comments": "sample string 12"
  }
]

Get customers created after date

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/DataExtract/Restaurant/{deploymentId}/{providerId}/Customers

Gets customers for a provider created on or after a supplied date.

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Path parameters

deploymentIdinteger · int32Required

The Id of the deployment that the restaurant is in.

providerIdinteger · int32Required

The restaurant's Id.

Query parameters

fromCreationDatestring · date-timeRequired

The customer creation date to start searching from.

includeBlockedCustomersbooleanOptional

True if the results should include blocked customers, false otherwise.

pageNumberinteger · int32Optional

The page number to return. Pages start at 1.

pageSizeinteger · int32Optional

The number of customers to return per page.

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

TotalRowsinteger · int32Optional

PageNumberinteger · int32Optional

TotalPagesinteger · int32Optional

PreviousUrlstringOptional

NextUrlstringOptional

get

/api/ConsumerApi/v1/DataExtract/Restaurant/{deploymentId}/{providerId}/Customers

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/DataExtract/Restaurant/{deploymentId}/{providerId}/Customers?fromCreationDate=2026-03-10T03%3A43%3A42.158Z HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "TotalRows": 1,
  "PageNumber": 2,
  "TotalPages": 3,
  "Data": [
    {
      "Id": 1,
      "Title": "sample string 2",
      "FirstName": "sample string 3",
      "Surname": "sample string 4",
      "Company": "sample string 5",
      "Department": "sample string 6",
      "Email": "sample string 7",
      "MobileCountryCode": 1,
      "Mobile": "sample string 8",
      "PhoneCountryCode": 1,
      "Phone": "sample string 9",
      "IsVip": true,
      "ReceiveEmailMarketing": true,
      "GroupEmailMarketingOptInText": "sample string 12",
      "GroupEmailMarketingOptInDateTime": "2025-09-18T14:22:59",
      "ReceiveSmsMarketing": true,
      "GroupSmsMarketingOptInText": "sample string 14",
      "GroupSmsMarketingOptInDateTime": "2025-09-18T14:22:59",
      "ReceiveRestaurantEmailMarketing": true,
      "RestaurantEmailMarketingOptInText": "sample string 15",
      "RestaurantEmailMarketingOptInDateTime": "2025-09-18T14:22:59",
      "ReceiveRestaurantSmsMarketing": true,
      "RestaurantSmsMarketingOptInText": "sample string 16",
      "RestaurantSmsMarketingOptInDateTime": "2025-09-18T14:22:59",
      "Comments": "sample string 17",
      "Birthday": "2025-09-18T14:22:59",
      "Anniversary": "2025-09-18T14:22:59",
      "IsDrinkingAge": true,
      "MembershipId": "sample string 19",
      "Field1": "sample string 20",
      "Field2": "sample string 21",
      "Field3": "sample string 22",
      "Field4": "sample string 23",
      "Field5": "sample string 24",
      "IsBlocked": true,
      "CustomerCodes": [
        1,
        2
      ],
      "CustomerCodesList": [
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        }
      ],
      "CustomerType": {
        "Id": 1,
        "Name": "sample string 2"
      },
      "Rank": 1,
      "Address": {
        "House": "sample string 1",
        "Street": "sample string 2",
        "Town": "sample string 3",
        "CountyRegion": "sample string 4",
        "Country": "sample string 5",
        "Postcode": "sample string 6"
      },
      "IsRoyaltyCardHolder": true,
      "CreatedDateTime": "2025-09-18T14:22:59",
      "CustomerMarketingSourceIpAddress": "sample string 28",
      "MarketingPreferencesUrl": "sample string 29"
    },
    {
      "Id": 1,
      "Title": "sample string 2",
      "FirstName": "sample string 3",
      "Surname": "sample string 4",
      "Company": "sample string 5",
      "Department": "sample string 6",
      "Email": "sample string 7",
      "MobileCountryCode": 1,
      "Mobile": "sample string 8",
      "PhoneCountryCode": 1,
      "Phone": "sample string 9",
      "IsVip": true,
      "ReceiveEmailMarketing": true,
      "GroupEmailMarketingOptInText": "sample string 12",
      "GroupEmailMarketingOptInDateTime": "2025-09-18T14:22:59",
      "ReceiveSmsMarketing": true,
      "GroupSmsMarketingOptInText": "sample string 14",
      "GroupSmsMarketingOptInDateTime": "2025-09-18T14:22:59",
      "ReceiveRestaurantEmailMarketing": true,
      "RestaurantEmailMarketingOptInText": "sample string 15",
      "RestaurantEmailMarketingOptInDateTime": "2025-09-18T14:22:59",
      "ReceiveRestaurantSmsMarketing": true,
      "RestaurantSmsMarketingOptInText": "sample string 16",
      "RestaurantSmsMarketingOptInDateTime": "2025-09-18T14:22:59",
      "Comments": "sample string 17",
      "Birthday": "2025-09-18T14:22:59",
      "Anniversary": "2025-09-18T14:22:59",
      "IsDrinkingAge": true,
      "MembershipId": "sample string 19",
      "Field1": "sample string 20",
      "Field2": "sample string 21",
      "Field3": "sample string 22",
      "Field4": "sample string 23",
      "Field5": "sample string 24",
      "IsBlocked": true,
      "CustomerCodes": [
        1,
        2
      ],
      "CustomerCodesList": [
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        }
      ],
      "CustomerType": {
        "Id": 1,
        "Name": "sample string 2"
      },
      "Rank": 1,
      "Address": {
        "House": "sample string 1",
        "Street": "sample string 2",
        "Town": "sample string 3",
        "CountyRegion": "sample string 4",
        "Country": "sample string 5",
        "Postcode": "sample string 6"
      },
      "IsRoyaltyCardHolder": true,
      "CreatedDateTime": "2025-09-18T14:22:59",
      "CustomerMarketingSourceIpAddress": "sample string 28",
      "MarketingPreferencesUrl": "sample string 29"
    }
  ],
  "PreviousUrl": "sample string 4",
  "NextUrl": "sample string 5"
}