Authentication credentials for your Toast API integration client software.
Type: objectProperties: 3
Food ServicePoint-of-SaleRestaurantHospitality
AuthenticationRequest is a JSON Structure definition published by Toast, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-structure/authentication-authentication-request-structure.json",
"name": "AuthenticationRequest",
"description": "Authentication credentials for your Toast API integration client software.\n",
"type": "object",
"properties": {
"clientId": {
"description": "The identifier string for your Toast API client. You receive the\nidentifier string from the Toast integrations team.\n",
"type": "string",
"example": "VKuhk4NaLedOcjZpJM8grvdrsFi3MlcM"
},
"clientSecret": {
"description": "The secret string that corresponds to your Toast API client. You\nreceive the secret string from the Toast integrations team.\n",
"type": "string",
"example": "eS960aiKdvgbSDcLUCk68HR2CJKwwHNO2HKfgxjCWxoj27KIp6jFAi2XOOc_oCuv"
},
"userAccessType": {
"description": "Always include the `userAccessType` value and set it to\n`TOAST_MACHINE_CLIENT`.\n",
"type": "string",
"example": "TOAST_MACHINE_CLIENT"
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.