Restaurant K Series Staff Api Posstaff Structure
staff-apiPOSStaff schema from Lightspeed Restaurant K Series API
Type: object
Properties: 14
POSRetailRestaurantEcommerce
staff-apiPOSStaff is a JSON Structure definition published by Lightspeed, describing 14 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/lightspeed-pos/refs/heads/main/json-structure/restaurant-k-series-staff-api-posstaff-structure.json",
"name": "staff-apiPOSStaff",
"description": "staff-apiPOSStaff schema from Lightspeed Restaurant K Series API",
"type": "object",
"properties": {
"staffId": {
"type": "int64",
"description": "The unique identifier for the user.",
"example": 1234
},
"username": {
"description": "The staff username. Only used for POS staff.",
"type": "string",
"x-nonempty": true,
"maxLength": 128,
"example": "John Doe"
},
"userTypes": {
"type": "array",
"items": {
"description": "The user type.",
"type": "string",
"enum": [
"POS",
"BACK_OFFICE",
"API"
]
}
},
"firstName": {
"type": "string",
"maxLength": 128,
"description": "The first name of the user.",
"default": "",
"example": "John"
},
"lastName": {
"type": "string",
"maxLength": 128,
"description": "The last name of the user.",
"default": "",
"example": "Doe"
},
"active": {
"type": "boolean",
"default": true,
"description": "Indicates if the user is active."
},
"pinCodeSet": {
"type": "boolean",
"description": "Indicates if the user has a PIN code set. Relevant for POS users only."
},
"createdOn": {
"type": "datetime",
"description": "The timestamp of the creation of the user."
},
"modifiedOn": {
"type": "datetime",
"description": "The timestamp of the last update to the user."
},
"businessId": {
"type": "int64",
"description": "The unique identifier for the business.",
"example": 12345
},
"businessLocationId": {
"type": "int64",
"description": "The unique identifier for the business location.",
"example": 1234567890
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "int64",
"description": "The unique identifier for the user group.",
"example": 1234
},
"name": {
"type": "string",
"description": "The name of the user group.",
"example": "Bar Staff"
}
}
}
},
"reportAccess": {
"type": "array",
"items": {
"type": "string",
"default": "STAFF_REPORT_OWN_ACCESS",
"description": "User report permissions."
}
},
"roles": {
"type": "array",
"description": "The roles assigned to the user.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "int64",
"description": "The unique identifier for the role.",
"example": 1234
},
"name": {
"type": "string",
"description": "The name of the role.",
"example": "ROLE_CAN_LOGIN"
}
}
}
}
}
}