Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.22 KB

v1-employee-role.md

File metadata and controls

36 lines (27 loc) · 1.22 KB

V1 Employee Role

V1EmployeeRole

Structure

V1 Employee Role

Fields

Name Type Tags Description
id string Optional The role's unique ID, Can only be set by Square.
name string Required The role's merchant-defined name.
permissions List of str (V1 Employee Role Permissions) Required The role's permissions.
See V1EmployeeRolePermissions for possible values
is_owner bool Optional If true, employees with this role have all permissions, regardless of the values indicated in permissions.
created_at string Optional The time when the employee entity was created, in ISO 8601 format. Is set by Square when the Role is created.
updated_at string Optional The time when the employee entity was most recently updated, in ISO 8601 format. Is set by Square when the Role updated.

Example (as JSON)

{
  "id": "id0",
  "name": "name0",
  "permissions": [
    "REGISTER_OPEN_CASH_DRAWER_OUTSIDE_SALE",
    "REGISTER_VIEW_SUMMARY_REPORTS"
  ],
  "is_owner": false,
  "created_at": "created_at2",
  "updated_at": "updated_at4"
}