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.

Working with guests (deprecated)

This section provides information about working with restaurant guest records in Toast APIs. You can use the Toast CRM (customer relations management) API to perform operations that affect restaurant guest records.


The CRM API is deprecated and will be replaced by future Toast API functionality. Before beginning development work using the CRM API, contact the Toast technical partnership team to make sure your integration plans are coordinated with upcoming API changes.

For detailed information about the endpoints and data structures of the CRM API, see CRM API (deprecated). For general information about the way the Toast POS handles guest records, see Guest data overview.

The Toast POS creates customer records when:

  • The POS processes takeout, delivery, and other types of orders that require customer information.

  • Restaurant employees give customer credits for future check payments.

  • The POS issues or imports gift or loyalty cards that require customer information.

  • Other restaurant and POS operations that include customer information.

The following sections provide more information about working with customers.