Customer Management
Authorizations
Query parameters
idstringRequired
Header parameters
X-API-KEYstringRequired
Partner API Key
X-API-SECRETstringRequired
Partner API Secret
Responses
200
The customer has been successfully retrieved.
application/json
400
Invalid input format.
401
Unauthorized
404
Customer not found.
get
/partners/customerGET /partners/customer?id=text HTTP/1.1
Host: api.fullwhere.com
X-API-KEY: text
X-API-SECRET: text
Accept: */*
{
"id": "text",
"createdAt": "2025-10-28T12:26:05.938Z",
"updatedAt": "2025-10-28T12:26:05.938Z",
"description": "text",
"company": "text",
"firstName": "text",
"lastName": "text",
"displayName": "text",
"language": "af",
"phoneNumber": "text",
"email": "text",
"emailBounced": true,
"civility": "text",
"tags": [
{
"id": "text",
"createdAt": "2025-10-28T12:26:05.938Z",
"updatedAt": "2025-10-28T12:26:05.938Z",
"tag": "text",
"color": "text"
}
],
"emailOptin": true,
"smsOptin": true,
"zenchefId": "text",
"ubereatsId": "text",
"deliverooId": "text",
"zeltyId": "text",
"sevenroomsId": "text",
"metaId": "text",
"mewsId": "text",
"oracleId": "text",
"partoucheId": "text",
"comoId": "text",
"theForkId": "text",
"type": "Unknown",
"feedbackCount": 1,
"purchaseCount": 1,
"averageFeedbackRating": "text",
"dataSources": [
"Google"
],
"metadata": {
"googleMyBusiness": {
"displayName": "text",
"profilePhotoUrl": "text",
"isAnonymous": true
},
"zelty": {
"metadata": {},
"id": 1,
"uuid": "text",
"remote_id": "text",
"nice_name": "text",
"updated_at": "text",
"name": "text",
"fname": "text",
"company": "text",
"card": "text",
"phone": "text",
"phone2": "text",
"mail": "text",
"birthday": "text",
"balance": 1,
"personal_info": "text",
"loyalty": 1,
"registration": "text",
"default_address": 1,
"billing_address": 1,
"sms_optin": true,
"mail_optin": true,
"turnover": 1,
"nb_orders": 1,
"last_order_date": "text",
"other": "text",
"addresses": [
{
"id": 1,
"remote_id": "text",
"name": "text",
"street": "text",
"street_num": "text",
"zip_code": "text",
"city": "text",
"formatted_address": "text",
"google_id": "text",
"location": [
1
],
"address_more": "text",
"floor": "text",
"door": "text",
"building": "text",
"code": "text"
}
],
"country_code": "text"
},
"zenchef": {
"id": 1,
"created_at": "text",
"updated_at": "text",
"deleted_at": "text",
"owner_id": 1,
"restaurantid": 1,
"restaurant_id": 1,
"retention_rate_label": "text",
"retention_rate": 1,
"company": "text",
"status": "text",
"account_id": 1,
"customer_social_id": "text",
"customer_company_id": "text",
"lastname": "text",
"firstname": "text",
"civility": "text",
"email": "text",
"phone": "text",
"professional_email": "text",
"professional_phone": "text",
"birthdate": "text",
"address": "text",
"city": "text",
"zip": "text",
"country": "text",
"lang": "text",
"membershipnum": "text",
"vip": 1,
"has_no_show": 1,
"is_new": 1,
"is_blacklisted": 1,
"allergies": "text",
"comment": "text",
"unsubscribed": true,
"has_opt_in_market_mail": 1,
"has_opt_in_review_mail": 1,
"imported_nb_bookings": 1,
"non_duplicate_with": "text",
"optins": [
{
"id": 1,
"customer_sheet_id": 1,
"type": {},
"value": true,
"is_last": 1,
"created_at": "text"
}
]
},
"juxta": {
"patient_fullname": "text",
"patient_firstname": "text",
"patient_lastname": "text",
"phone_number": "text",
"email": "text"
},
"salesforce": {
"dentego": {
"EXTERNAL_ID__c": "text",
"Centre_du_RDV__c": "text",
"Type_de_RDV__c": "text",
"EnddatepourProcessbuilder__c": "text",
"Statut__c": "text",
"Pas_de_R_ponse__c": true,
"Motif_du_RDV__c": "text",
"Pas_int_ress__c": true,
"Recontacter_ce_soir__c": true,
"Commentaire_support_Th_o__c": "text",
"X1er_contact_par_SMS__c": true,
"Nombre_de_RDV_non_honor__c": 1,
"Action_r_alis_e__c": "text",
"Commentaire_li_l_action_r_alis_e__c": "text",
"Recontacter_le__c": "text",
"KO__c": true,
"Date_du_RDV__c": "text",
"Commentaire_li_e_la_t_che__c": "text",
"RDV_plant__c": 1,
"Is_RDV__c": 1,
"Logiciel_met__c": "text",
"Date_d_annulation_du_RDV__c": "text",
"RDV_ADMIN__c": 1,
"DateFlow__c": "text",
"Mail__c": "text",
"Mobile__c": "text",
"isFinished__c": true,
"techSentToHelloCustomer__c": true,
"P_rim_tre_r_gional__c": "text",
"Etat_de_confirmation__c": "text",
"Traite_dans_Doctolib__c": true,
"Date_d_envoi_de_la_confirmation__c": "text",
"Date_de_r_ponse__c": "text",
"Type_de_demande__c": "text",
"Aujourd_hui__c": "text",
"Voyant__c": "text",
"Event_date_1er_RDV__c": "text",
"RDV_NP__c": true,
"Date_de_prise_du_RDV__c": "text"
}
},
"deliveroo": {
"id": 1,
"frequency": 1
},
"tripadvisor": {
"helpfulVotes": 1,
"contributionCount": 1,
"homeTown": "text",
"avatarUrl": "text",
"username": "text"
},
"booking": {
"yourname": "text"
},
"ubereats": {
"name": "text",
"profileURL": "text",
"uuid": "text",
"isEatsPassSubscriber": true,
"numOrders": 1
},
"sevenrooms": {
"first_name": "text",
"last_name": "text",
"email": "text",
"phone_number": "text",
"client_id": "text",
"venue_group_client_id": "text",
"client_reference_code": "text",
"external_client_id": "text",
"source_client_id": "text",
"reservation_sms_opt_in": true
},
"facebook": {
"id": "text",
"profile_pic": "text",
"first_name": "text",
"last_name": "text",
"name": "text",
"name_format": "text",
"gender": "text"
},
"instagram": {
"id": "text",
"biography": "text",
"profile_picture_url": "text",
"profile_pic": "text",
"followers_count": "text",
"follows_count": "text",
"media_count": "text",
"username": "text",
"name": "text",
"website": "text"
},
"whatsapp": {
"wa_id": "text",
"profile": {
"name": "text"
}
},
"mews": {
"customer": {
"Id": "text",
"ChainId": "text",
"Number": "text",
"FirstName": "text",
"LastName": "text",
"SecondLastName": "text",
"Title": "text",
"Sex": "text",
"NationalityCode": "text",
"LanguageCode": "text",
"BirthDate": "text",
"BirthPlace": "text",
"Email": "text",
"Phone": "text",
"TaxIdentificationNumber": "text",
"LoyaltyCode": "text",
"AccountingCode": "text",
"BillingCode": "text",
"Notes": "text",
"CarRegistrationNumber": "text",
"Classifications": [
"text"
],
"Options": [
"text"
],
"Address": {
"Id": "text",
"Line1": "text",
"Line2": "text",
"City": "text",
"PostalCode": "text",
"CountryCode": "text",
"CountrySubdivisionCode": "text",
"Latitude": 1,
"Longitude": 1
},
"CreatedUtc": "text",
"UpdatedUtc": "text",
"ItalianDestinationCode": "text",
"ItalianFiscalCode": "text",
"CompanyId": "text",
"MergeTargetId": "text",
"ActivityState": "text",
"CitizenNumber": "text",
"MotherName": "text",
"FatherName": "text",
"Occupation": "text",
"HasOtaEmail": true,
"Passport": "text",
"IdentityCard": "text",
"Visa": "text",
"DriversLicense": "text",
"AddressId": "text",
"CategoryId": "text",
"BirthDateUtc": "text",
"IsActive": true,
"IsUpdatedByMe": true
},
"documents": [
{
"Id": "text",
"CustomerId": "text",
"Type": "text",
"Number": "text",
"Expiration": "text",
"Issuance": "text",
"IssuingCountryCode": "text",
"IssuingCity": "text"
}
]
},
"oracle": {
"membership": {
"membershipId": 1,
"programCode": "text",
"bonusCode": "text",
"membershipTypeDesc": "text",
"membershipLevelDesc": "text",
"accountId": "text",
"membershipLevel": "text",
"playerRanking": 1
},
"namePrefix": "text",
"givenName": "text",
"alternateGivenName": "text",
"middleName": "text",
"surname": "text",
"alternateSurname": "text",
"nameTitle": "text",
"fullName": "text",
"phoneNumber": "text",
"email": "text",
"birthDate": "2025-10-28T12:26:05.938Z",
"language": "text",
"nationality": {
"value": "text",
"code": "text",
"displayCountryFlag": true,
"isoCode": "text"
},
"vip": {
"vipCode": "text",
"vipDescription": "text"
},
"address": {
"cityName": "text",
"postalCode": "text",
"state": "text",
"streetAddress": "text",
"country": {
"value": "text",
"code": "text"
},
"excludeNoCity": true
},
"anonymization": {
"anonymizationStatus": "text"
},
"accompanyGuests": [
{
"firstName": "text",
"lastName": "text",
"fullName": "text",
"registrationCardNo": "text",
"profileIdList": [
{
"id": "text",
"type": "text"
}
]
}
],
"guestLastStayInformation": {
"lastStayDate": "2025-10-28T12:26:05.938Z",
"lastStayRoom": "text",
"lastStayRate": {
"amount": 1,
"currencyCode": "text"
},
"totalStay": 1
},
"guestRestrictedCode": "text",
"guestRestrictedReasonDesc": "text",
"guestRestricted": true,
"registrationCardNo": "text",
"nameType": "text",
"id": "text",
"type": "text"
},
"partouche": {
"id": 1,
"mail": "text",
"name": "text",
"firstname": "text",
"lastname": "text",
"civility": 1,
"optout": true,
"optout_source": "text",
"testuser": true,
"only_text": true,
"subscribe_source": "text",
"subscribe_source_detail": "text",
"created_dt": "2025-10-28T12:26:05.938Z",
"modified_dt": "2025-10-28T12:26:05.938Z",
"optout_dt": "2025-10-28T12:26:05.938Z",
"language": "text",
"bouncecnt": 1,
"bouncedt": "2025-10-28T12:26:05.938Z",
"mobile": "text",
"valide_email": true,
"valide_print": true,
"valide_sms": true,
"abo_email": true,
"abo_sms": true,
"abo_print": true,
"casino_rattachement": "text",
"id_contact": "text",
"today": "2025-10-28T12:26:05.938Z",
"do_not_contact": true
},
"como": {
"membership": {
"MembershipStatus": "text",
"AccumulatedPoints": "text",
"Email": "text",
"LastUpdate": "text",
"BudgetWeighted": "text",
"UserKey": "text",
"LocationID": "text",
"Points": "text",
"AllowEmail": "text",
"Consent": "text",
"Assets": [
{}
],
"Kind": "text",
"CreatedOn": "text",
"RegistrationSource": "text",
"WeightedPoints": "text",
"AllowSMS": "text",
"UnweightedBudgetPoints": "text",
"Status": "text",
"FirstName": "text",
"ConsentForHub": "text",
"PreviousUserKeys": [
"text"
],
"EntityId": "text",
"CommonExtID": "text",
"PhoneNumber": "text",
"LastName": "text",
"Tag": [
"text"
],
"BudgetAccumulatedUnweighted": "text",
"BudgetUnweighted": "text",
"BudgetAccumulatedWeighted": "text",
"Key": "text",
"ComoMemberID": "text"
},
"assets": [
{
"template": "text",
"type": "text",
"key": "text",
"status": "text"
}
]
},
"experience": {
"customer_custom_properties": [
{}
],
"customer_additional_properties": [
{}
],
"email": "text",
"title": "text",
"firstname": "text",
"lastname": "text",
"language": "text",
"birthdate": "text",
"age_at_time_of_stay": 1,
"addr_street": "text",
"addr_city": "text",
"addr_zipcode": "text",
"addr_country": "text",
"continent": "text",
"nationality": "text",
"mobile_phone": "text",
"phone": "text",
"number_of_stays": 1,
"often_travel_to_city": true
},
"autoGestion": {
"firstname": "text",
"lastname": "text",
"email": "text",
"phone": "text",
"thoroughfare": "text",
"premise": "text",
"postal_code": "text",
"locality": "text",
"country": "text"
},
"theFork": {
"customerUuid": "text",
"email": "text",
"firstName": "text",
"lastName": "text",
"phone": "text",
"birthDate": "text",
"locale": "text",
"civility": "text",
"rank": "text",
"computedRank": "text",
"isVip": true,
"address": "text",
"allergiesAndIntolerances": [
"text"
],
"dietaryRestrictions": [
"text"
],
"favFood": "text",
"favDrinks": "text",
"favSeating": "text",
"notes": "text",
"originRestaurantUuid": "text",
"originRestaurantName": "text",
"creationDate": "text",
"lastUpdateDate": "text",
"isPromoter": true,
"secondaryPhone": "text",
"country": "text",
"city": "text",
"zipcode": "text",
"optins": {
"restaurantNewsletter": true
},
"customFields": [
{
"labelUuid": "text",
"label": "text",
"type": {},
"value": "text",
"valueUuid": "text"
}
]
},
"import": {}
}
}Authorizations
Header parameters
X-API-KEYstringRequired
Partner API Key
X-API-SECRETstringRequired
Partner API Secret
Body
descriptionstring | nullableOptional
Description of the customer
companystring | nullableOptional
Company name of the customer
firstNamestring | nullableOptional
First name of the customer
lastNamestring | nullableOptional
Last name of the customer
displayNamestring | nullableOptional
Display name of the customer Usually a concatenation of first name and last name
phoneNumberstring | nullableOptional
Phone number of the customer
emailstring · email | nullableOptional
Email address of the customer
civilitystring | nullableOptional
Civility of the customer (e.g., Mr., Ms., etc.)
languageall of | nullableOptional
Language preference of the customer
string · enumOptionalPossible values:
metadataobjectOptional
Additional metadata to store with the customer This is a key-value pair object where both keys and values are strings
smsOptinboolean | nullableOptional
SMS opt-in status of the customer
emailOptinboolean | nullableOptional
Email opt-in status of the customer
zenchefIdstring | nullableOptional
ID of the customer in Zenchef system
ubereatsIdstring | nullableOptional
ID of the customer in UberEats system
deliverooIdstring | nullableOptional
ID of the customer in Deliveroo system
zeltyIdstring | nullableOptional
ID of the customer in Zelty system
sevenroomsIdstring | nullableOptional
ID of the customer in Sevenrooms system
metaIdstring | nullableOptional
ID of the customer in Meta system (Facebook/Instagram)
mewsIdstring | nullableOptional
ID of the customer in Mews system
oracleIdstring | nullableOptional
ID of the customer in Oracle system
partoucheIdstring | nullableOptional
ID of the customer in Partouche system
comoIdstring | nullableOptional
ID of the customer in Como system
theForkIdstring | nullableOptional
ID of the customer in TheFork system
Responses
201
The customer has been successfully imported.
application/json
400
Invalid input format.
401
Unauthorized
post
/partners/customerPOST /partners/customer HTTP/1.1
Host: api.fullwhere.com
X-API-KEY: text
X-API-SECRET: text
Content-Type: application/json
Accept: */*
Content-Length: 430
{
"description": "text",
"company": "text",
"firstName": "text",
"lastName": "text",
"displayName": "text",
"phoneNumber": "text",
"email": "[email protected]",
"civility": "text",
"language": "af",
"metadata": {},
"smsOptin": true,
"emailOptin": true,
"zenchefId": "text",
"ubereatsId": "text",
"deliverooId": "text",
"zeltyId": "text",
"sevenroomsId": "text",
"metaId": "text",
"mewsId": "text",
"oracleId": "text",
"partoucheId": "text",
"comoId": "text",
"theForkId": "text"
}{
"id": "text",
"createdAt": "2025-10-28T12:26:05.938Z",
"updatedAt": "2025-10-28T12:26:05.938Z",
"description": "text",
"company": "text",
"firstName": "text",
"lastName": "text",
"displayName": "text",
"language": "af",
"phoneNumber": "text",
"email": "text",
"emailBounced": true,
"civility": "text",
"tags": [
{
"id": "text",
"createdAt": "2025-10-28T12:26:05.938Z",
"updatedAt": "2025-10-28T12:26:05.938Z",
"tag": "text",
"color": "text"
}
],
"emailOptin": true,
"smsOptin": true,
"zenchefId": "text",
"ubereatsId": "text",
"deliverooId": "text",
"zeltyId": "text",
"sevenroomsId": "text",
"metaId": "text",
"mewsId": "text",
"oracleId": "text",
"partoucheId": "text",
"comoId": "text",
"theForkId": "text",
"type": "Unknown",
"feedbackCount": 1,
"purchaseCount": 1,
"averageFeedbackRating": "text",
"dataSources": [
"Google"
],
"metadata": {
"googleMyBusiness": {
"displayName": "text",
"profilePhotoUrl": "text",
"isAnonymous": true
},
"zelty": {
"metadata": {},
"id": 1,
"uuid": "text",
"remote_id": "text",
"nice_name": "text",
"updated_at": "text",
"name": "text",
"fname": "text",
"company": "text",
"card": "text",
"phone": "text",
"phone2": "text",
"mail": "text",
"birthday": "text",
"balance": 1,
"personal_info": "text",
"loyalty": 1,
"registration": "text",
"default_address": 1,
"billing_address": 1,
"sms_optin": true,
"mail_optin": true,
"turnover": 1,
"nb_orders": 1,
"last_order_date": "text",
"other": "text",
"addresses": [
{
"id": 1,
"remote_id": "text",
"name": "text",
"street": "text",
"street_num": "text",
"zip_code": "text",
"city": "text",
"formatted_address": "text",
"google_id": "text",
"location": [
1
],
"address_more": "text",
"floor": "text",
"door": "text",
"building": "text",
"code": "text"
}
],
"country_code": "text"
},
"zenchef": {
"id": 1,
"created_at": "text",
"updated_at": "text",
"deleted_at": "text",
"owner_id": 1,
"restaurantid": 1,
"restaurant_id": 1,
"retention_rate_label": "text",
"retention_rate": 1,
"company": "text",
"status": "text",
"account_id": 1,
"customer_social_id": "text",
"customer_company_id": "text",
"lastname": "text",
"firstname": "text",
"civility": "text",
"email": "text",
"phone": "text",
"professional_email": "text",
"professional_phone": "text",
"birthdate": "text",
"address": "text",
"city": "text",
"zip": "text",
"country": "text",
"lang": "text",
"membershipnum": "text",
"vip": 1,
"has_no_show": 1,
"is_new": 1,
"is_blacklisted": 1,
"allergies": "text",
"comment": "text",
"unsubscribed": true,
"has_opt_in_market_mail": 1,
"has_opt_in_review_mail": 1,
"imported_nb_bookings": 1,
"non_duplicate_with": "text",
"optins": [
{
"id": 1,
"customer_sheet_id": 1,
"type": {},
"value": true,
"is_last": 1,
"created_at": "text"
}
]
},
"juxta": {
"patient_fullname": "text",
"patient_firstname": "text",
"patient_lastname": "text",
"phone_number": "text",
"email": "text"
},
"salesforce": {
"dentego": {
"EXTERNAL_ID__c": "text",
"Centre_du_RDV__c": "text",
"Type_de_RDV__c": "text",
"EnddatepourProcessbuilder__c": "text",
"Statut__c": "text",
"Pas_de_R_ponse__c": true,
"Motif_du_RDV__c": "text",
"Pas_int_ress__c": true,
"Recontacter_ce_soir__c": true,
"Commentaire_support_Th_o__c": "text",
"X1er_contact_par_SMS__c": true,
"Nombre_de_RDV_non_honor__c": 1,
"Action_r_alis_e__c": "text",
"Commentaire_li_l_action_r_alis_e__c": "text",
"Recontacter_le__c": "text",
"KO__c": true,
"Date_du_RDV__c": "text",
"Commentaire_li_e_la_t_che__c": "text",
"RDV_plant__c": 1,
"Is_RDV__c": 1,
"Logiciel_met__c": "text",
"Date_d_annulation_du_RDV__c": "text",
"RDV_ADMIN__c": 1,
"DateFlow__c": "text",
"Mail__c": "text",
"Mobile__c": "text",
"isFinished__c": true,
"techSentToHelloCustomer__c": true,
"P_rim_tre_r_gional__c": "text",
"Etat_de_confirmation__c": "text",
"Traite_dans_Doctolib__c": true,
"Date_d_envoi_de_la_confirmation__c": "text",
"Date_de_r_ponse__c": "text",
"Type_de_demande__c": "text",
"Aujourd_hui__c": "text",
"Voyant__c": "text",
"Event_date_1er_RDV__c": "text",
"RDV_NP__c": true,
"Date_de_prise_du_RDV__c": "text"
}
},
"deliveroo": {
"id": 1,
"frequency": 1
},
"tripadvisor": {
"helpfulVotes": 1,
"contributionCount": 1,
"homeTown": "text",
"avatarUrl": "text",
"username": "text"
},
"booking": {
"yourname": "text"
},
"ubereats": {
"name": "text",
"profileURL": "text",
"uuid": "text",
"isEatsPassSubscriber": true,
"numOrders": 1
},
"sevenrooms": {
"first_name": "text",
"last_name": "text",
"email": "text",
"phone_number": "text",
"client_id": "text",
"venue_group_client_id": "text",
"client_reference_code": "text",
"external_client_id": "text",
"source_client_id": "text",
"reservation_sms_opt_in": true
},
"facebook": {
"id": "text",
"profile_pic": "text",
"first_name": "text",
"last_name": "text",
"name": "text",
"name_format": "text",
"gender": "text"
},
"instagram": {
"id": "text",
"biography": "text",
"profile_picture_url": "text",
"profile_pic": "text",
"followers_count": "text",
"follows_count": "text",
"media_count": "text",
"username": "text",
"name": "text",
"website": "text"
},
"whatsapp": {
"wa_id": "text",
"profile": {
"name": "text"
}
},
"mews": {
"customer": {
"Id": "text",
"ChainId": "text",
"Number": "text",
"FirstName": "text",
"LastName": "text",
"SecondLastName": "text",
"Title": "text",
"Sex": "text",
"NationalityCode": "text",
"LanguageCode": "text",
"BirthDate": "text",
"BirthPlace": "text",
"Email": "text",
"Phone": "text",
"TaxIdentificationNumber": "text",
"LoyaltyCode": "text",
"AccountingCode": "text",
"BillingCode": "text",
"Notes": "text",
"CarRegistrationNumber": "text",
"Classifications": [
"text"
],
"Options": [
"text"
],
"Address": {
"Id": "text",
"Line1": "text",
"Line2": "text",
"City": "text",
"PostalCode": "text",
"CountryCode": "text",
"CountrySubdivisionCode": "text",
"Latitude": 1,
"Longitude": 1
},
"CreatedUtc": "text",
"UpdatedUtc": "text",
"ItalianDestinationCode": "text",
"ItalianFiscalCode": "text",
"CompanyId": "text",
"MergeTargetId": "text",
"ActivityState": "text",
"CitizenNumber": "text",
"MotherName": "text",
"FatherName": "text",
"Occupation": "text",
"HasOtaEmail": true,
"Passport": "text",
"IdentityCard": "text",
"Visa": "text",
"DriversLicense": "text",
"AddressId": "text",
"CategoryId": "text",
"BirthDateUtc": "text",
"IsActive": true,
"IsUpdatedByMe": true
},
"documents": [
{
"Id": "text",
"CustomerId": "text",
"Type": "text",
"Number": "text",
"Expiration": "text",
"Issuance": "text",
"IssuingCountryCode": "text",
"IssuingCity": "text"
}
]
},
"oracle": {
"membership": {
"membershipId": 1,
"programCode": "text",
"bonusCode": "text",
"membershipTypeDesc": "text",
"membershipLevelDesc": "text",
"accountId": "text",
"membershipLevel": "text",
"playerRanking": 1
},
"namePrefix": "text",
"givenName": "text",
"alternateGivenName": "text",
"middleName": "text",
"surname": "text",
"alternateSurname": "text",
"nameTitle": "text",
"fullName": "text",
"phoneNumber": "text",
"email": "text",
"birthDate": "2025-10-28T12:26:05.938Z",
"language": "text",
"nationality": {
"value": "text",
"code": "text",
"displayCountryFlag": true,
"isoCode": "text"
},
"vip": {
"vipCode": "text",
"vipDescription": "text"
},
"address": {
"cityName": "text",
"postalCode": "text",
"state": "text",
"streetAddress": "text",
"country": {
"value": "text",
"code": "text"
},
"excludeNoCity": true
},
"anonymization": {
"anonymizationStatus": "text"
},
"accompanyGuests": [
{
"firstName": "text",
"lastName": "text",
"fullName": "text",
"registrationCardNo": "text",
"profileIdList": [
{
"id": "text",
"type": "text"
}
]
}
],
"guestLastStayInformation": {
"lastStayDate": "2025-10-28T12:26:05.938Z",
"lastStayRoom": "text",
"lastStayRate": {
"amount": 1,
"currencyCode": "text"
},
"totalStay": 1
},
"guestRestrictedCode": "text",
"guestRestrictedReasonDesc": "text",
"guestRestricted": true,
"registrationCardNo": "text",
"nameType": "text",
"id": "text",
"type": "text"
},
"partouche": {
"id": 1,
"mail": "text",
"name": "text",
"firstname": "text",
"lastname": "text",
"civility": 1,
"optout": true,
"optout_source": "text",
"testuser": true,
"only_text": true,
"subscribe_source": "text",
"subscribe_source_detail": "text",
"created_dt": "2025-10-28T12:26:05.938Z",
"modified_dt": "2025-10-28T12:26:05.938Z",
"optout_dt": "2025-10-28T12:26:05.938Z",
"language": "text",
"bouncecnt": 1,
"bouncedt": "2025-10-28T12:26:05.938Z",
"mobile": "text",
"valide_email": true,
"valide_print": true,
"valide_sms": true,
"abo_email": true,
"abo_sms": true,
"abo_print": true,
"casino_rattachement": "text",
"id_contact": "text",
"today": "2025-10-28T12:26:05.938Z",
"do_not_contact": true
},
"como": {
"membership": {
"MembershipStatus": "text",
"AccumulatedPoints": "text",
"Email": "text",
"LastUpdate": "text",
"BudgetWeighted": "text",
"UserKey": "text",
"LocationID": "text",
"Points": "text",
"AllowEmail": "text",
"Consent": "text",
"Assets": [
{}
],
"Kind": "text",
"CreatedOn": "text",
"RegistrationSource": "text",
"WeightedPoints": "text",
"AllowSMS": "text",
"UnweightedBudgetPoints": "text",
"Status": "text",
"FirstName": "text",
"ConsentForHub": "text",
"PreviousUserKeys": [
"text"
],
"EntityId": "text",
"CommonExtID": "text",
"PhoneNumber": "text",
"LastName": "text",
"Tag": [
"text"
],
"BudgetAccumulatedUnweighted": "text",
"BudgetUnweighted": "text",
"BudgetAccumulatedWeighted": "text",
"Key": "text",
"ComoMemberID": "text"
},
"assets": [
{
"template": "text",
"type": "text",
"key": "text",
"status": "text"
}
]
},
"experience": {
"customer_custom_properties": [
{}
],
"customer_additional_properties": [
{}
],
"email": "text",
"title": "text",
"firstname": "text",
"lastname": "text",
"language": "text",
"birthdate": "text",
"age_at_time_of_stay": 1,
"addr_street": "text",
"addr_city": "text",
"addr_zipcode": "text",
"addr_country": "text",
"continent": "text",
"nationality": "text",
"mobile_phone": "text",
"phone": "text",
"number_of_stays": 1,
"often_travel_to_city": true
},
"autoGestion": {
"firstname": "text",
"lastname": "text",
"email": "text",
"phone": "text",
"thoroughfare": "text",
"premise": "text",
"postal_code": "text",
"locality": "text",
"country": "text"
},
"theFork": {
"customerUuid": "text",
"email": "text",
"firstName": "text",
"lastName": "text",
"phone": "text",
"birthDate": "text",
"locale": "text",
"civility": "text",
"rank": "text",
"computedRank": "text",
"isVip": true,
"address": "text",
"allergiesAndIntolerances": [
"text"
],
"dietaryRestrictions": [
"text"
],
"favFood": "text",
"favDrinks": "text",
"favSeating": "text",
"notes": "text",
"originRestaurantUuid": "text",
"originRestaurantName": "text",
"creationDate": "text",
"lastUpdateDate": "text",
"isPromoter": true,
"secondaryPhone": "text",
"country": "text",
"city": "text",
"zipcode": "text",
"optins": {
"restaurantNewsletter": true
},
"customFields": [
{
"labelUuid": "text",
"label": "text",
"type": {},
"value": "text",
"valueUuid": "text"
}
]
},
"import": {}
}
}Authorizations
Header parameters
X-API-KEYstringRequired
Partner API Key
X-API-SECRETstringRequired
Partner API Secret
Body
limitnumber · min: 1 · max: 100OptionalDefault:
Pagination limit
10pagenumber · min: 1OptionalDefault:
Page to retrieve
1Responses
201
The customers have been successfully listed.
application/json
400
Invalid input format.
401
Unauthorized
post
/partners/customer/listPOST /partners/customer/list HTTP/1.1
Host: api.fullwhere.com
X-API-KEY: text
X-API-SECRET: text
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"limit": 10,
"page": 1
}{
"items": [
{
"id": "text",
"createdAt": "2025-10-28T12:26:05.938Z",
"updatedAt": "2025-10-28T12:26:05.938Z",
"description": "text",
"company": "text",
"firstName": "text",
"lastName": "text",
"displayName": "text",
"language": "af",
"phoneNumber": "text",
"email": "text",
"emailBounced": true,
"civility": "text",
"tags": [
{
"id": "text",
"createdAt": "2025-10-28T12:26:05.938Z",
"updatedAt": "2025-10-28T12:26:05.938Z",
"tag": "text",
"color": "text"
}
],
"emailOptin": true,
"smsOptin": true,
"zenchefId": "text",
"ubereatsId": "text",
"deliverooId": "text",
"zeltyId": "text",
"sevenroomsId": "text",
"metaId": "text",
"mewsId": "text",
"oracleId": "text",
"partoucheId": "text",
"comoId": "text",
"theForkId": "text",
"type": "Unknown",
"feedbackCount": 1,
"purchaseCount": 1,
"averageFeedbackRating": "text",
"dataSources": [
"Google"
],
"metadata": {
"googleMyBusiness": {
"displayName": "text",
"profilePhotoUrl": "text",
"isAnonymous": true
},
"zelty": {
"metadata": {},
"id": 1,
"uuid": "text",
"remote_id": "text",
"nice_name": "text",
"updated_at": "text",
"name": "text",
"fname": "text",
"company": "text",
"card": "text",
"phone": "text",
"phone2": "text",
"mail": "text",
"birthday": "text",
"balance": 1,
"personal_info": "text",
"loyalty": 1,
"registration": "text",
"default_address": 1,
"billing_address": 1,
"sms_optin": true,
"mail_optin": true,
"turnover": 1,
"nb_orders": 1,
"last_order_date": "text",
"other": "text",
"addresses": [
{
"id": 1,
"remote_id": "text",
"name": "text",
"street": "text",
"street_num": "text",
"zip_code": "text",
"city": "text",
"formatted_address": "text",
"google_id": "text",
"location": [
1
],
"address_more": "text",
"floor": "text",
"door": "text",
"building": "text",
"code": "text"
}
],
"country_code": "text"
},
"zenchef": {
"id": 1,
"created_at": "text",
"updated_at": "text",
"deleted_at": "text",
"owner_id": 1,
"restaurantid": 1,
"restaurant_id": 1,
"retention_rate_label": "text",
"retention_rate": 1,
"company": "text",
"status": "text",
"account_id": 1,
"customer_social_id": "text",
"customer_company_id": "text",
"lastname": "text",
"firstname": "text",
"civility": "text",
"email": "text",
"phone": "text",
"professional_email": "text",
"professional_phone": "text",
"birthdate": "text",
"address": "text",
"city": "text",
"zip": "text",
"country": "text",
"lang": "text",
"membershipnum": "text",
"vip": 1,
"has_no_show": 1,
"is_new": 1,
"is_blacklisted": 1,
"allergies": "text",
"comment": "text",
"unsubscribed": true,
"has_opt_in_market_mail": 1,
"has_opt_in_review_mail": 1,
"imported_nb_bookings": 1,
"non_duplicate_with": "text",
"optins": [
{
"id": 1,
"customer_sheet_id": 1,
"type": {},
"value": true,
"is_last": 1,
"created_at": "text"
}
]
},
"juxta": {
"patient_fullname": "text",
"patient_firstname": "text",
"patient_lastname": "text",
"phone_number": "text",
"email": "text"
},
"salesforce": {
"dentego": {
"EXTERNAL_ID__c": "text",
"Centre_du_RDV__c": "text",
"Type_de_RDV__c": "text",
"EnddatepourProcessbuilder__c": "text",
"Statut__c": "text",
"Pas_de_R_ponse__c": true,
"Motif_du_RDV__c": "text",
"Pas_int_ress__c": true,
"Recontacter_ce_soir__c": true,
"Commentaire_support_Th_o__c": "text",
"X1er_contact_par_SMS__c": true,
"Nombre_de_RDV_non_honor__c": 1,
"Action_r_alis_e__c": "text",
"Commentaire_li_l_action_r_alis_e__c": "text",
"Recontacter_le__c": "text",
"KO__c": true,
"Date_du_RDV__c": "text",
"Commentaire_li_e_la_t_che__c": "text",
"RDV_plant__c": 1,
"Is_RDV__c": 1,
"Logiciel_met__c": "text",
"Date_d_annulation_du_RDV__c": "text",
"RDV_ADMIN__c": 1,
"DateFlow__c": "text",
"Mail__c": "text",
"Mobile__c": "text",
"isFinished__c": true,
"techSentToHelloCustomer__c": true,
"P_rim_tre_r_gional__c": "text",
"Etat_de_confirmation__c": "text",
"Traite_dans_Doctolib__c": true,
"Date_d_envoi_de_la_confirmation__c": "text",
"Date_de_r_ponse__c": "text",
"Type_de_demande__c": "text",
"Aujourd_hui__c": "text",
"Voyant__c": "text",
"Event_date_1er_RDV__c": "text",
"RDV_NP__c": true,
"Date_de_prise_du_RDV__c": "text"
}
},
"deliveroo": {
"id": 1,
"frequency": 1
},
"tripadvisor": {
"helpfulVotes": 1,
"contributionCount": 1,
"homeTown": "text",
"avatarUrl": "text",
"username": "text"
},
"booking": {
"yourname": "text"
},
"ubereats": {
"name": "text",
"profileURL": "text",
"uuid": "text",
"isEatsPassSubscriber": true,
"numOrders": 1
},
"sevenrooms": {
"first_name": "text",
"last_name": "text",
"email": "text",
"phone_number": "text",
"client_id": "text",
"venue_group_client_id": "text",
"client_reference_code": "text",
"external_client_id": "text",
"source_client_id": "text",
"reservation_sms_opt_in": true
},
"facebook": {
"id": "text",
"profile_pic": "text",
"first_name": "text",
"last_name": "text",
"name": "text",
"name_format": "text",
"gender": "text"
},
"instagram": {
"id": "text",
"biography": "text",
"profile_picture_url": "text",
"profile_pic": "text",
"followers_count": "text",
"follows_count": "text",
"media_count": "text",
"username": "text",
"name": "text",
"website": "text"
},
"whatsapp": {
"wa_id": "text",
"profile": {
"name": "text"
}
},
"mews": {
"customer": {
"Id": "text",
"ChainId": "text",
"Number": "text",
"FirstName": "text",
"LastName": "text",
"SecondLastName": "text",
"Title": "text",
"Sex": "text",
"NationalityCode": "text",
"LanguageCode": "text",
"BirthDate": "text",
"BirthPlace": "text",
"Email": "text",
"Phone": "text",
"TaxIdentificationNumber": "text",
"LoyaltyCode": "text",
"AccountingCode": "text",
"BillingCode": "text",
"Notes": "text",
"CarRegistrationNumber": "text",
"Classifications": [
"text"
],
"Options": [
"text"
],
"Address": {
"Id": "text",
"Line1": "text",
"Line2": "text",
"City": "text",
"PostalCode": "text",
"CountryCode": "text",
"CountrySubdivisionCode": "text",
"Latitude": 1,
"Longitude": 1
},
"CreatedUtc": "text",
"UpdatedUtc": "text",
"ItalianDestinationCode": "text",
"ItalianFiscalCode": "text",
"CompanyId": "text",
"MergeTargetId": "text",
"ActivityState": "text",
"CitizenNumber": "text",
"MotherName": "text",
"FatherName": "text",
"Occupation": "text",
"HasOtaEmail": true,
"Passport": "text",
"IdentityCard": "text",
"Visa": "text",
"DriversLicense": "text",
"AddressId": "text",
"CategoryId": "text",
"BirthDateUtc": "text",
"IsActive": true,
"IsUpdatedByMe": true
},
"documents": [
{
"Id": "text",
"CustomerId": "text",
"Type": "text",
"Number": "text",
"Expiration": "text",
"Issuance": "text",
"IssuingCountryCode": "text",
"IssuingCity": "text"
}
]
},
"oracle": {
"membership": {
"membershipId": 1,
"programCode": "text",
"bonusCode": "text",
"membershipTypeDesc": "text",
"membershipLevelDesc": "text",
"accountId": "text",
"membershipLevel": "text",
"playerRanking": 1
},
"namePrefix": "text",
"givenName": "text",
"alternateGivenName": "text",
"middleName": "text",
"surname": "text",
"alternateSurname": "text",
"nameTitle": "text",
"fullName": "text",
"phoneNumber": "text",
"email": "text",
"birthDate": "2025-10-28T12:26:05.938Z",
"language": "text",
"nationality": {
"value": "text",
"code": "text",
"displayCountryFlag": true,
"isoCode": "text"
},
"vip": {
"vipCode": "text",
"vipDescription": "text"
},
"address": {
"cityName": "text",
"postalCode": "text",
"state": "text",
"streetAddress": "text",
"country": {
"value": "text",
"code": "text"
},
"excludeNoCity": true
},
"anonymization": {
"anonymizationStatus": "text"
},
"accompanyGuests": [
{
"firstName": "text",
"lastName": "text",
"fullName": "text",
"registrationCardNo": "text",
"profileIdList": [
{
"id": "text",
"type": "text"
}
]
}
],
"guestLastStayInformation": {
"lastStayDate": "2025-10-28T12:26:05.938Z",
"lastStayRoom": "text",
"lastStayRate": {
"amount": 1,
"currencyCode": "text"
},
"totalStay": 1
},
"guestRestrictedCode": "text",
"guestRestrictedReasonDesc": "text",
"guestRestricted": true,
"registrationCardNo": "text",
"nameType": "text",
"id": "text",
"type": "text"
},
"partouche": {
"id": 1,
"mail": "text",
"name": "text",
"firstname": "text",
"lastname": "text",
"civility": 1,
"optout": true,
"optout_source": "text",
"testuser": true,
"only_text": true,
"subscribe_source": "text",
"subscribe_source_detail": "text",
"created_dt": "2025-10-28T12:26:05.938Z",
"modified_dt": "2025-10-28T12:26:05.938Z",
"optout_dt": "2025-10-28T12:26:05.938Z",
"language": "text",
"bouncecnt": 1,
"bouncedt": "2025-10-28T12:26:05.938Z",
"mobile": "text",
"valide_email": true,
"valide_print": true,
"valide_sms": true,
"abo_email": true,
"abo_sms": true,
"abo_print": true,
"casino_rattachement": "text",
"id_contact": "text",
"today": "2025-10-28T12:26:05.938Z",
"do_not_contact": true
},
"como": {
"membership": {
"MembershipStatus": "text",
"AccumulatedPoints": "text",
"Email": "text",
"LastUpdate": "text",
"BudgetWeighted": "text",
"UserKey": "text",
"LocationID": "text",
"Points": "text",
"AllowEmail": "text",
"Consent": "text",
"Assets": [
{}
],
"Kind": "text",
"CreatedOn": "text",
"RegistrationSource": "text",
"WeightedPoints": "text",
"AllowSMS": "text",
"UnweightedBudgetPoints": "text",
"Status": "text",
"FirstName": "text",
"ConsentForHub": "text",
"PreviousUserKeys": [
"text"
],
"EntityId": "text",
"CommonExtID": "text",
"PhoneNumber": "text",
"LastName": "text",
"Tag": [
"text"
],
"BudgetAccumulatedUnweighted": "text",
"BudgetUnweighted": "text",
"BudgetAccumulatedWeighted": "text",
"Key": "text",
"ComoMemberID": "text"
},
"assets": [
{
"template": "text",
"type": "text",
"key": "text",
"status": "text"
}
]
},
"experience": {
"customer_custom_properties": [
{}
],
"customer_additional_properties": [
{}
],
"email": "text",
"title": "text",
"firstname": "text",
"lastname": "text",
"language": "text",
"birthdate": "text",
"age_at_time_of_stay": 1,
"addr_street": "text",
"addr_city": "text",
"addr_zipcode": "text",
"addr_country": "text",
"continent": "text",
"nationality": "text",
"mobile_phone": "text",
"phone": "text",
"number_of_stays": 1,
"often_travel_to_city": true
},
"autoGestion": {
"firstname": "text",
"lastname": "text",
"email": "text",
"phone": "text",
"thoroughfare": "text",
"premise": "text",
"postal_code": "text",
"locality": "text",
"country": "text"
},
"theFork": {
"customerUuid": "text",
"email": "text",
"firstName": "text",
"lastName": "text",
"phone": "text",
"birthDate": "text",
"locale": "text",
"civility": "text",
"rank": "text",
"computedRank": "text",
"isVip": true,
"address": "text",
"allergiesAndIntolerances": [
"text"
],
"dietaryRestrictions": [
"text"
],
"favFood": "text",
"favDrinks": "text",
"favSeating": "text",
"notes": "text",
"originRestaurantUuid": "text",
"originRestaurantName": "text",
"creationDate": "text",
"lastUpdateDate": "text",
"isPromoter": true,
"secondaryPhone": "text",
"country": "text",
"city": "text",
"zipcode": "text",
"optins": {
"restaurantNewsletter": true
},
"customFields": [
{
"labelUuid": "text",
"label": "text",
"type": {},
"value": "text",
"valueUuid": "text"
}
]
},
"import": {}
}
}
],
"meta": {
"itemCount": 1,
"totalItems": 1,
"itemsPerPage": 1,
"totalPages": 1,
"currentPage": 1
}
}Authorizations
Header parameters
X-API-KEYstringRequired
Partner API Key
X-API-SECRETstringRequired
Partner API Secret
Body
Responses
201
The customers have been successfully imported.
application/json
Responseany
400
Invalid input format.
401
Unauthorized
post
/partners/customer/batchPOST /partners/customer/batch HTTP/1.1
Host: api.fullwhere.com
X-API-KEY: text
X-API-SECRET: text
Content-Type: application/json
Accept: */*
Content-Length: 442
{
"batch": [
{
"description": "text",
"company": "text",
"firstName": "text",
"lastName": "text",
"displayName": "text",
"phoneNumber": "text",
"email": "[email protected]",
"civility": "text",
"language": "af",
"metadata": {},
"smsOptin": true,
"emailOptin": true,
"zenchefId": "text",
"ubereatsId": "text",
"deliverooId": "text",
"zeltyId": "text",
"sevenroomsId": "text",
"metaId": "text",
"mewsId": "text",
"oracleId": "text",
"partoucheId": "text",
"comoId": "text",
"theForkId": "text"
}
]
}No content
Last updated