Skip to content
Mews Open API

Get all customers

POST
/api/connector/v1/customers/getAll

Returns all customers filtered by identifiers, emails, names and other filters. Note this operation uses Pagination and supports Portfolio Access Tokens.

Request Body

Section titled “Request Body ”
CustomerFilterParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
ChainIds

Unique identifiers of the chains. Required when using Portfolio Access Tokens, ignored otherwise.

Array<string>
nullable >= 1 items <= 1000 items
CreatedUtc
TimeFilterInterval

Interval in which Customer was created.

object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
UpdatedUtc
TimeFilterInterval

Interval in which Customer was updated.

object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
Extent
required
Customer extent

Extent of data to be returned.

object
Customers

Whether the response should contain information about customers.

boolean
nullable
Documents

Whether the response should contain identity documents of customers.

boolean
nullable
Addresses

Whether the response should contain addresses of customers.

boolean
nullable
DeletedUtc
TimeFilterInterval

Interval in which Customer was deleted. ActivityStates value Deleted should be provided with this filter to get expected results.

object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
ActivityStates

Whether to return only active, only deleted or both records.

Array<string>
nullable
Allowed values: Deleted Active
CustomerIds

Unique identifiers of Customers. Required if no other filter is provided.

Array<string>
nullable >= 1 items <= 1000 items
CompanyIds

Unique identifier of the Company the customer is associated with.

Array<string>
nullable >= 1 items <= 1 items
Emails

Emails of the Customers.

Array<string>
nullable >= 1 items <= 1000 items
FirstNames

First names of the Customers.

Array<string>
nullable >= 1 items <= 1000 items
LastNames

Last names of the Customers.

Array<string>
nullable >= 1 items <= 1000 items
LoyaltyCodes

Loyalty codes of the Customers.

Array<string>
nullable >= 1 items <= 1000 items
Limitation
required

Limitation on the quantity of data returned.

object
Count
required
integer format: int32
Cursor
string format: uuid
nullable
Example
{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ChainIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "5fcd1933-22f2-40b9-84da-7db04cbecec2"
  ],
  "CreatedUtc": {
    "StartUtc": "2018-01-01T00:00:00Z",
    "EndUtc": "2018-01-30T00:00:00Z"
  },
  "UpdatedUtc": {
    "StartUtc": "2018-01-02T00:00:00Z",
    "EndUtc": "2018-01-30T00:00:00Z"
  },
  "Extent": {
    "Customers": true,
    "Documents": false,
    "Addresses": false
  },
  "ActivityStates": [
    "Active"
  ],
  "CustomerIds": [
    "fadd5bb6-b428-45d5-94f8-fd0d89fece6d"
  ],
  "CompanyIds": [
    "c6f5c82d-621a-4c8a-903b-1b0a9a23b71f"
  ],
  "Emails": [
    "j.smith@example.com"
  ],
  "FirstNames": [
    "John",
    "Jane"
  ],
  "LastNames": [
    "Doe",
    "Smith"
  ],
  "LoyaltyCodes": [
    "LL810213"
  ],
  "Limitation": {
    "Count": 10
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

CustomerResult
object
Customers
required

The customers.

Array<object>
Customer
object
Id
required

Unique identifier of the customer.

string format: uuid
ChainId
required

Unique identifier of the chain.

string format: uuid
Number
required

Number of the customer.

string
>= 1 characters
Title

Title of the customer.

Mister (Mr.)

Miss (Ms.)

Misses (Mrs.)

string
Allowed values: Mister Miss Misses
Sex

Sex of the customer.

Male

Female

string
Allowed values: Male Female
FirstName

First name of the customer.

string
nullable
LastName
required

Last name of the customer.

string
>= 1 characters
SecondLastName

Second last name of the customer.

string
nullable
NationalityCode

ISO 3166-1 code of the Country.

string
nullable
PreferredLanguageCode

Language and culture code of the customer’s preferred language, according to their profile. For example: en-GB, fr-CA.

string
nullable
LanguageCode

Language and culture code of the customer’s language, based on multiple sources. These sources include the preferred language specified in internal data based on previous bookings, and the preferred language of the customer specified in their profile. If neither of these sources are present, we use the native language based on the customer’s nationality. The format is, for example, en-US or fr-FR.

string
nullable
BirthDate

Date of birth in ISO 8601 format.

string
nullable
BirthPlace

Place of birth.

string
nullable
Occupation

Occupation of the customer.

string
nullable
Email

Email address of the customer.

string
nullable
HasOtaEmail

Whether the customer’s email address is a temporary email address from an OTA. For more details, see the product documentation.

boolean
Phone

Phone number of the customer (possibly mobile).

string
nullable
TaxIdentificationNumber

Tax identification number of the customer.

string
nullable
LoyaltyCode

Loyalty code of the customer.

string
nullable
AccountingCode

Accounting code of the customer.

string
nullable
BillingCode

Billing code of the customer.

string
nullable
Notes

Internal notes about the customer.

string
nullable
CarRegistrationNumber

Registration number of the customer’s car.

string
nullable <= 255 characters
DietaryRequirements

Customer’s dietary requirements, e.g. Vegan, Halal.

string
nullable <= 255 characters
CreatedUtc
required

Creation date and time of the customer in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the customer in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
Passport
Identity document
object
Id

Unique identifier of the document.

string format: uuid
CustomerId

Identifier of the Customer.

string format: uuid
Type
Document type

Type of the document.

IdentityCard

Passport

Visa

DriversLicense

string
Allowed values: IdentityCard Passport Visa DriversLicense
Number

Number of the document (e.g. passport number).

string
nullable
Expiration

Expiration date in ISO 8601 format.

string format: date
nullable
Issuance

Date of issuance in ISO 8601 format.

string format: date
nullable
IssuingCountryCode

ISO 3166-1 code of the Country.

string
nullable
IssuingCity

City where the document was issued.

string
nullable
IdentityDocumentSupportNumber

Identity document support number. Only required for Spanish identity cards in Spanish hotels.

string
nullable
IdentityCard
Identity document
object
Id

Unique identifier of the document.

string format: uuid
CustomerId

Identifier of the Customer.

string format: uuid
Type
Document type

Type of the document.

IdentityCard

Passport

Visa

DriversLicense

string
Allowed values: IdentityCard Passport Visa DriversLicense
Number

Number of the document (e.g. passport number).

string
nullable
Expiration

Expiration date in ISO 8601 format.

string format: date
nullable
Issuance

Date of issuance in ISO 8601 format.

string format: date
nullable
IssuingCountryCode

ISO 3166-1 code of the Country.

string
nullable
IssuingCity

City where the document was issued.

string
nullable
IdentityDocumentSupportNumber

Identity document support number. Only required for Spanish identity cards in Spanish hotels.

string
nullable
Visa
Identity document
object
Id

Unique identifier of the document.

string format: uuid
CustomerId

Identifier of the Customer.

string format: uuid
Type
Document type

Type of the document.

IdentityCard

Passport

Visa

DriversLicense

string
Allowed values: IdentityCard Passport Visa DriversLicense
Number

Number of the document (e.g. passport number).

string
nullable
Expiration

Expiration date in ISO 8601 format.

string format: date
nullable
Issuance

Date of issuance in ISO 8601 format.

string format: date
nullable
IssuingCountryCode

ISO 3166-1 code of the Country.

string
nullable
IssuingCity

City where the document was issued.

string
nullable
IdentityDocumentSupportNumber

Identity document support number. Only required for Spanish identity cards in Spanish hotels.

string
nullable
DriversLicense
Identity document
object
Id

Unique identifier of the document.

string format: uuid
CustomerId

Identifier of the Customer.

string format: uuid
Type
Document type

Type of the document.

IdentityCard

Passport

Visa

DriversLicense

string
Allowed values: IdentityCard Passport Visa DriversLicense
Number

Number of the document (e.g. passport number).

string
nullable
Expiration

Expiration date in ISO 8601 format.

string format: date
nullable
Issuance

Date of issuance in ISO 8601 format.

string format: date
nullable
IssuingCountryCode

ISO 3166-1 code of the Country.

string
nullable
IssuingCity

City where the document was issued.

string
nullable
IdentityDocumentSupportNumber

Identity document support number. Only required for Spanish identity cards in Spanish hotels.

string
nullable
Address
Address
object
Id

Unique identifier of the address.

string format: uuid
Line1

First line of the address.

string
nullable
Line2

Second line of the address.

string
nullable
City

The city.

string
nullable
PostalCode

Postal code.

string
nullable
CountryCode

ISO 3166-1 code of the Country.

string
nullable
CountrySubdivisionCode

ISO 3166-2 code of the administrative division, e.g. DE-BW.

string
nullable
Latitude

The latitude.

number format: double
nullable
Longitude

The longitude.

number format: double
nullable
AddressId

Unique identifier of the Address of the customer.

string format: uuid
nullable
Classifications
required

Classifications of the customer.

Array<string>
Allowed values: None PaymasterAccount Blacklist Media LoyaltyProgram PreviousComplaint Returning Staff FriendOrFamily TopManagement Important VeryImportant Problematic Cashlist DisabledPerson Military Airline HealthCompliant InRoom WaitingForRoom Student
Options
required

Options of the customer.

Array<string>
Allowed values: None SendMarketingEmails Invoiceable BillAddressObjection SendMarketingPostalMail SendPartnerMarketingEmails SendPartnerMarketingPostalMail WithdrawCardConsent GuestPhotoConsent IdPhotosConsent
ItalianDestinationCode

Value of Italian destination code.

string
nullable
ItalianFiscalCode

Value of Italian fiscal code.

string
nullable
CompanyId

Unique identifier of Company the customer is associated with.

string format: uuid
nullable
MergeTargetId

Unique identifier of the account (Customer) to which this customer is linked.

string format: uuid
nullable
ActivityState

Activity State of customer record, i.e. whether active or deleted.

string
nullable
IsActive
required

Whether the customer record is still active.

boolean
PreferredSpaceFeatures
required

A list of room preferences, such as view type, bed type, and amenities.

Array<string>
Allowed values: SeaView RiverView OceanView TwinBeds DoubleBed RollawayBed UpperBed LowerBed Balcony AccessibleBathroom AccessibleRoom ElevatorAccess HighFloor Kitchenette AirConditioning PrivateJacuzzi PrivateSauna EnsuiteRoom PrivateBathroom SharedBathroom
CreatorProfileId
required

Unique identifier of the user who created the customer.

string format: uuid
UpdaterProfileId
required

Unique identifier of the user who last updated the customer.

string format: uuid
Documents

The identity documents of customers.

Array<object>
nullable
Identity document
object
Id

Unique identifier of the document.

string format: uuid
CustomerId

Identifier of the Customer.

string format: uuid
Type
Document type

Type of the document.

IdentityCard

Passport

Visa

DriversLicense

string
Allowed values: IdentityCard Passport Visa DriversLicense
Number

Number of the document (e.g. passport number).

string
nullable
Expiration

Expiration date in ISO 8601 format.

string format: date
nullable
Issuance

Date of issuance in ISO 8601 format.

string format: date
nullable
IssuingCountryCode

ISO 3166-1 code of the Country.

string
nullable
IssuingCity

City where the document was issued.

string
nullable
IdentityDocumentSupportNumber

Identity document support number. Only required for Spanish identity cards in Spanish hotels.

string
nullable
Cursor

Unique identifier of the last and hence oldest customer item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older customers. If Limitation is specified in the request message, then Cursor will always be included in the response message; this is true even when using Extents set to false so that no actual data is returned.

string format: uuid
nullable
Example
{
  "Customers": [
    {
      "Id": "fadd5bb6-b428-45d5-94f8-fd0d89fece6d",
      "ChainId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Number": "12345",
      "Title": "Mister",
      "Sex": "Male",
      "FirstName": "John",
      "LastName": "Smith",
      "SecondLastName": "Williams",
      "NationalityCode": "US",
      "PreferredLanguageCode": "en-GB",
      "LanguageCode": "en-US",
      "BirthDate": "1983-12-31",
      "BirthPlace": "New York City, NY",
      "Occupation": "Carpenter",
      "Email": "j.smith@example.com",
      "HasOtaEmail": false,
      "Phone": "00420123456789",
      "TaxIdentificationNumber": "123456789",
      "LoyaltyCode": "LL810213",
      "AccountingCode": "AC123",
      "BillingCode": null,
      "Notes": "",
      "CarRegistrationNumber": "1A2 3456",
      "DietaryRequirements": null,
      "CreatedUtc": "2018-01-01T00:00:00Z",
      "UpdatedUtc": "2018-01-02T00:00:00Z",
      "Passport": null,
      "IdentityCard": null,
      "Visa": null,
      "DriversLicense": null,
      "Address": {
        "Id": "f8495413-bf49-45dd-843c-44be7f365569",
        "Line1": "Somerford Road Hello House/135",
        "Line2": null,
        "City": "Christchurch",
        "PostalCode": "BH23 3PY",
        "CountryCode": "GB",
        "CountrySubdivisionCode": "GB-ENG",
        "Latitude": null,
        "Longitude": null
      },
      "AddressId": "f8495413-bf49-45dd-843c-44be7f365569",
      "Classifications": [
        "Returning"
      ],
      "Options": [
        "SendMarketingEmails"
      ],
      "ItalianDestinationCode": null,
      "ItalianFiscalCode": null,
      "CompanyId": "c6f5c82d-621a-4c8a-903b-1b0a9a23b71f",
      "MergeTargetId": null,
      "ActivityState": "Active",
      "IsActive": true,
      "PreferredSpaceFeatures": [
        "OceanView"
      ],
      "CreatorProfileId": "3cd637ef-4728-47f9-8fb1-afb900c9cdcf",
      "UpdaterProfileId": "122fc063-ec6e-4198-b8db-6b168a59ffae"
    }
  ],
  "Documents": null,
  "Cursor": "fadd5bb6-b428-45d5-94f8-fd0d89fece6d"
}

204

Section titled “204 ”

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

400

Section titled “400 ”

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

401

Section titled “401 ”

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

403

Section titled “403 ”

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

408

Section titled “408 ”

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

429

Section titled “429 ”

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

500

Section titled “500 ”

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable