ExternalReference

A wrapper object with fields that allow reference to a Toast platform entity by Toast GUID.

entityType
required
string

The type of object this is.

externalId
string

External identifier string that is prefixed by the naming authority. You can, for example, use the labor API to POST an externalId for an employee and then GET the employee with that externalId.

guid
required
string

The GUID maintained by the Toast platform.

{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string"
}