{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/json-schema/labor-external-reference-schema.json", "title": "ExternalReference", "description": "A wrapper object with fields that allow reference to a Toast \nplatform entity by Toast GUID or an external identifier.\n", "type": "object", "allOf": [ { "$ref": "#/$defs/ToastReference" }, { "type": "object", "properties": { "externalId": { "description": "External identifier string that is prefixed by the naming \nauthority. You can, for example, use the labor API to \n`POST` an `externalId` for an employee and then `GET` the \nemployee with that `externalId`.\n", "type": "string" } } } ], "$defs": { "ToastReference": { "type": "object", "description": "A wrapper object with fields that allow reference to a Toast \nplatform entity by Toast GUID.\n", "required": [ "guid", "entityType" ], "properties": { "guid": { "description": "The GUID maintained by the Toast platform.\n", "type": "string", "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1" }, "entityType": { "description": "The type of object this is.\n", "type": "string", "example": "string" } } } } }