Documentation contents
GET/data/customers

Synchronize customers

Scope: customers:read

Query parameters

modestring
The documented operation mode.
Values: "snapshot" · "changes"
limitinteger
Page size: 50 by default, at most 100.
Range: 1 – 100
cursorstring
The previously returned cursor, passed unchanged.
Response 200 · fields
Variant 1
modestringrequired
The documented operation mode.
Values: "snapshot"
dataarrayrequired
Authorized resource data.
Fields data
Variant 1
idstringrequired
The resource identifier.
Format: uuid
card_idstringrequired
The Mereu card UUID.
Format: uuid
location_idstringrequired
The authorized Mereu location UUID; inside external_ref, your own store identifier.
Format: uuid
first_namestring / nullrequired
last_namestring / nullrequired
emailstring / nullrequired
phone_e164string / nullrequired
marketing_opt_inbooleanrequired
created_atstringrequired
Format: date-time
updated_atstringrequired
Format: date-time
deletedbooleanrequired
Indicates data to remove from the local copy.
Values: false
Variant 2
idstringrequired
The resource identifier.
Format: uuid
deletedbooleanrequired
Indicates data to remove from the local copy.
Values: true
updated_atstring
Format: date-time
next_cursorstring / nullrequired
The next page; null when complete.
sync_cursorstringrequired
The saved position for changes to this same resource.
Variant 2
modestringrequired
The documented operation mode.
Values: "changes"
dataarrayrequired
Authorized resource data.
Fields data
event_idstringrequired
The notification identifier; its current body can be updated on replay.
record_idstringrequired
The identifier of the changed resource.
Format: uuid
operationstringrequired
Apply upsert or delete by resource identifier.
Values: "upsert" · "delete"
changed_atstringrequired
Format: date-time
datavariantsrequired
Authorized resource data.
Fields data
next_cursorstring / nullrequired
The next page; null when complete.
sync_cursorstringrequired
The saved position for changes to this same resource.

Errors and retrying requests: recovery guide →