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.

Client identifier and secret

API users must register with the Toast technical partnership team for each environment to obtain the client credentials to use with that environment. In this context, client refers to the software that you use to exchange information with Toast APIs.

API client credentials include:

  • Client identifier - A unique application identifier that the service API uses to identify the partner application. A client identifier is comparable to an account name.

  • Client secret - A private string assigned by Toast used to verify the identity of the partner application to the service API when the application makes requests to Toast services. This secret must be kept private between the partner and the Toast technical partnership team.

    The client secret is similar to a password. Do not use email to send or receive a Toast API client secret.