Toast · JSON Structure

Authentication Authentication Response Structure

A wrapper object for the response to a successful Toast API authentication request.

Type: object Properties: 2
Food ServicePoint of SaleRestaurantsHospitality

AuthenticationResponse is a JSON Structure definition published by Toast, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

token status

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/refs/heads/main/json-structure/authentication-authentication-response-structure.json",
  "name": "AuthenticationResponse",
  "description": "A wrapper object for the response to a successful Toast API authentication\nrequest.\n",
  "type": "object",
  "properties": {
    "token": {
      "description": "An `AuthenticationToken` object containing information about a Toast\nplatform API session, including an authentication token string that\nyour Toast API client software can present when using other Toast\nplatform APIs.\n",
      "type": "object",
      "$ref": "#/definitions/AuthenticationToken"
    },
    "status": {
      "description": "The value `SUCCESS` indicates that your authentication request was successful.",
      "type": "string",
      "example": "SUCCESS"
    }
  }
}