--- title: "Get all customers" method: POST path: "/api/connector/v1/customers/getAll" tags: ["Customers"] --- # 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](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). ## Request body - CustomerFilterParameters - `ClientToken` string, required — Token identifying the client application. - `AccessToken` string, required — Access token of the client application. - `Client` string, required — Name and version of the client application. - `ChainIds` string[], nullable — Unique identifiers of the chains. Required when using Portfolio Access Tokens, ignored otherwise. - `CreatedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted. - `StartUtc` string, date-time, nullable - `EndUtc` string, date-time, nullable - `UpdatedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted. - `StartUtc` string, date-time, nullable - `EndUtc` string, date-time, nullable - `Extent` CustomerExtent, required - `Customers` boolean, nullable — Whether the response should contain information about customers. - `Documents` boolean, nullable — Whether the response should contain identity documents of customers. - `Addresses` boolean, nullable — Whether the response should contain addresses of customers. - `DeletedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted. - `StartUtc` string, date-time, nullable - `EndUtc` string, date-time, nullable - `ActivityStates` ActivityStates[], nullable — Whether to return only active, only deleted or both records. - `CustomerIds` string[], nullable — Unique identifiers of Customers. Required if no other filter is provided. - `CompanyIds` string[], nullable — Unique identifier of the Company the customer is associated with. - `Emails` string[], nullable — Emails of the [Customers](https://mews-systems.gitbook.io/connector-api/operations/#customer). - `FirstNames` string[], nullable — First names of the [Customers](https://mews-systems.gitbook.io/connector-api/operations/#customer). - `LastNames` string[], nullable — Last names of the [Customers](https://mews-systems.gitbook.io/connector-api/operations/#customer). - `LoyaltyCodes` string[], nullable — Loyalty codes of the [Customers](https://mews-systems.gitbook.io/connector-api/operations/#customer). - `Limitation` Limitation, required — Limitation on the quantity of data returned. - `Count` integer, required - `Cursor` string, uuid, nullable ## Response `200` OK - CustomerResult - `Customers` Customer[], required — The customers. - `Id` string, uuid, required — Unique identifier of the customer. - `ChainId` string, uuid, required — Unique identifier of the chain. - `Number` string, required — Unique number of the customer (max 19 digits). - `Title` 'Mister' | 'Miss' | 'Misses' — Type of the title prefix of the customer. Note that the value should not be used as-is, but localized. For example, the value `Misses` should be displayed as `Mrs.` in English and `Fr.` in German. Mister (Mr.) Miss (Ms.) Misses (Mrs.) - `CustomTitleName` string, nullable — Name of the customer's custom title, as configured in the chain's guest titles. Mutually exclusive with `Title`. - `Sex` 'Male' | 'Female' — Male Female - `FirstName` string, nullable — First name of the customer. - `LastName` string, required — Last name of the customer. - `SecondLastName` string, nullable — Second last name of the customer. - `NationalityCode` string, nullable — ISO 3166-1 code of the [Country](https://mews-systems.gitbook.io/connector-api/operations/countries/#country). - `PreferredLanguageCode` string, nullable — Language and culture code of the customer's preferred language, according to their profile. For example: `en-GB`, `fr-CA`. - `LanguageCode` string, nullable — 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`. - `BirthDate` string, nullable — Date of birth in ISO 8601 format. - `BirthCountryCode` string, nullable — ISO 3166-1 alpha-2 code of the birth country. - `BirthCountrySubdivisionCode` string, nullable — ISO 3166-2 code of the administrative division, e.g. ES-C. - `BirthPlace` string, nullable — Place of birth. - `Occupation` string, nullable — Occupation of the customer. - `Email` string, nullable — Email address of the customer. - `HasOtaEmail` boolean — Whether the customer's email address is a temporary email address from an OTA. For more details, see the [product documentation](https://help.mews.com/s/article/how-to-maintain-ota-guest-profiles-with-verified-email-addresses-obtained-from-the-guest-portal). - `Phone` string, nullable — Phone number of the customer (possibly mobile). - `TaxIdentificationNumber` string, nullable — Tax identification number of the customer. - `LoyaltyCode` string, nullable — Loyalty code of the customer. - `AccountingCode` string, nullable — Accounting code of the customer. - `BillingCode` string, nullable — Billing code of the customer. - `Notes` string, nullable — Internal notes about the customer. - `CarRegistrationNumber` string, nullable — Registration number of the customer's car. - `DietaryRequirements` string, nullable — Customer's dietary requirements, e.g. Vegan, Halal. - `CreatedUtc` string, date-time, required — Creation date and time of the customer in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the customer in UTC timezone in ISO 8601 format. - `Passport` IdentityDocument - `Id` string, uuid — Unique identifier of the document. - `CustomerId` string, uuid — Identifier of the `Customer`. - `Type` 'IdentityCard' | 'Passport' | 'Visa' | 'DriversLicense' — IdentityCard Passport Visa DriversLicense - `Number` string, nullable — Number of the document (e.g. passport number). - `Expiration` string, date, nullable — Expiration date in ISO 8601 format. - `Issuance` string, date, nullable — Date of issuance in ISO 8601 format. - `IssuingCountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `IssuingCountrySubdivisionCode` string, nullable — Identifier of the country subdivision where the document was issued (province, state or region). - `IssuingCity` string, nullable — City where the document was issued. - `IdentityDocumentSupportNumber` string, nullable — Identity document support number. Only required for Spanish identity cards in Spanish hotels. - `IdentityCard` IdentityDocument - `Id` string, uuid — Unique identifier of the document. - `CustomerId` string, uuid — Identifier of the `Customer`. - `Type` 'IdentityCard' | 'Passport' | 'Visa' | 'DriversLicense' — IdentityCard Passport Visa DriversLicense - `Number` string, nullable — Number of the document (e.g. passport number). - `Expiration` string, date, nullable — Expiration date in ISO 8601 format. - `Issuance` string, date, nullable — Date of issuance in ISO 8601 format. - `IssuingCountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `IssuingCountrySubdivisionCode` string, nullable — Identifier of the country subdivision where the document was issued (province, state or region). - `IssuingCity` string, nullable — City where the document was issued. - `IdentityDocumentSupportNumber` string, nullable — Identity document support number. Only required for Spanish identity cards in Spanish hotels. - `Visa` IdentityDocument - `Id` string, uuid — Unique identifier of the document. - `CustomerId` string, uuid — Identifier of the `Customer`. - `Type` 'IdentityCard' | 'Passport' | 'Visa' | 'DriversLicense' — IdentityCard Passport Visa DriversLicense - `Number` string, nullable — Number of the document (e.g. passport number). - `Expiration` string, date, nullable — Expiration date in ISO 8601 format. - `Issuance` string, date, nullable — Date of issuance in ISO 8601 format. - `IssuingCountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `IssuingCountrySubdivisionCode` string, nullable — Identifier of the country subdivision where the document was issued (province, state or region). - `IssuingCity` string, nullable — City where the document was issued. - `IdentityDocumentSupportNumber` string, nullable — Identity document support number. Only required for Spanish identity cards in Spanish hotels. - `DriversLicense` IdentityDocument - `Id` string, uuid — Unique identifier of the document. - `CustomerId` string, uuid — Identifier of the `Customer`. - `Type` 'IdentityCard' | 'Passport' | 'Visa' | 'DriversLicense' — IdentityCard Passport Visa DriversLicense - `Number` string, nullable — Number of the document (e.g. passport number). - `Expiration` string, date, nullable — Expiration date in ISO 8601 format. - `Issuance` string, date, nullable — Date of issuance in ISO 8601 format. - `IssuingCountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `IssuingCountrySubdivisionCode` string, nullable — Identifier of the country subdivision where the document was issued (province, state or region). - `IssuingCity` string, nullable — City where the document was issued. - `IdentityDocumentSupportNumber` string, nullable — Identity document support number. Only required for Spanish identity cards in Spanish hotels. - `Address` OldAddress - `Id` string, uuid — Unique identifier of the address. - `Line1` string, nullable — First line of the address. - `Line2` string, nullable — Second line of the address. - `City` string, nullable — The city. - `PostalCode` string, nullable — Postal code. - `CountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `CountrySubdivisionCode` string, nullable — ISO 3166-2 code of the administrative division, e.g. `DE-BW`. - `Latitude` number, double, nullable — The latitude. - `Longitude` number, double, nullable — The longitude. - `AddressId` string, uuid, nullable — Unique identifier of the `Address` of the customer. - `Classifications` CustomerClassificationEnum[], required — Classifications of the customer. - `Options` CustomerOptionsEnum[], required — Options of the customer. - `ItalianDestinationCode` string, nullable — Value of Italian destination code. - `ItalianFiscalCode` string, nullable — Value of Italian fiscal code. - `ItalianLotteryCode` string, nullable — Italian lottery code. - `CompanyId` string, uuid, nullable — Unique identifier of [Company](https://mews-systems.gitbook.io/connector-api/operations/companies/#company) the customer is associated with. - `MergeTargetId` string, uuid, nullable — Unique identifier of the account ([Customer](https://mews-systems.gitbook.io/connector-api/operations/#customer)) to which this customer is linked. - `ActivityState` string, nullable — [Activity State](https://mews-systems.gitbook.io/connector-api/operations/#activity-state) of customer record, i.e. whether active or deleted. - `IsActive` boolean, required — Whether the customer record is still active. - `PreferredSpaceFeatures` ResourceFeatureClassification[], required — A list of room preferences, such as view type, bed type, and amenities. - `CreatorProfileId` string, uuid, required — Unique identifier of the user who created the customer. - `UpdaterProfileId` string, uuid, required — Unique identifier of the user who last updated the customer. - `Documents` IdentityDocument[], nullable — The identity documents of customers. - `Id` string, uuid — Unique identifier of the document. - `CustomerId` string, uuid — Identifier of the `Customer`. - `Type` 'IdentityCard' | 'Passport' | 'Visa' | 'DriversLicense' — IdentityCard Passport Visa DriversLicense - `Number` string, nullable — Number of the document (e.g. passport number). - `Expiration` string, date, nullable — Expiration date in ISO 8601 format. - `Issuance` string, date, nullable — Date of issuance in ISO 8601 format. - `IssuingCountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `IssuingCountrySubdivisionCode` string, nullable — Identifier of the country subdivision where the document was issued (province, state or region). - `IssuingCity` string, nullable — City where the document was issued. - `IdentityDocumentSupportNumber` string, nullable — Identity document support number. Only required for Spanish identity cards in Spanish hotels. - `Cursor` string, uuid, nullable — Unique identifier of the last and hence oldest customer item returned. This can be used in [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) in a subsequent request to fetch the next batch of older customers. If [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#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. ## Other responses - `204` — Server has successfully fulfilled the request and there is no additional information to send back. - `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). - `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. - `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. - `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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) - `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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). - `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](https://github.com/MewsSystems/gitbook-connector-api). --- [API](https://skmtc.net/mews/apis/connector-api.md) · [All operations](https://skmtc.net/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/connector-api/revisions/eb29e5887d8a/schema)