Toast · JSON Structure

Authentication Authentication Request Structure

Authentication credentials for your Toast API integration client software.

Type: object Properties: 3
RestaurantsPoint Of SalePaymentsOnline OrderingDeliveryLoyaltyGift CardsMenusOrdersKitchenLaborSchedulingInventoryHospitalityPartner Integrations

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.

Properties

clientId clientSecret userAccessType

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast-tab/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"
    }
  }
}