This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.
To find existing customer records in the Toast POS you send a
POST request to the
/crm/v1/customers/search endpoint of the CRM API.
You must include A JSON CustomerSearchRequest object
containing a CustomerSearchQuery object in a
POST request to search for existing customer
records. The CustomerSearchQuery object includes information
about the customer you are searching for. For example, if you are
searching for a customer record with a telephone number, you submit a
POST request including a message body that
consists of a CustomerSearchRequest object with a
query value containing a CustomerSearchQuery
object. The CustomerSearchQuery object contains a
phone value with the telephone number that you want to
match.
The following example shows the message body for a
POST request to the
/crm/v1/customers/search endpoint.