V1EmployeeRole Object- Square API Reference

Name	Description
`id string`	The role's unique ID, Can only be set by Square.
`name string` Required	The role's merchant-defined name.
`permissions string [ ]` Required	The role's permissions. See V1EmployeeRolePermissions for possible values
`is_owner boolean`	If true, employees with this role have all permissions, regardless of the values indicated in permissions.
`created_at string`	The time when the employee entity was created, in ISO 8601 format. Is set by Square when the Role is created.
`updated_at string`	The time when the employee entity was most recently updated, in ISO 8601 format. Is set by Square when the Role updated.

The role's unique ID, Can only be set by Square.

Required

The role's merchant-defined name.


        
  
  
          permissions
        


        

        
    string [ ]

Required

The role's permissions. See V1EmployeeRolePermissions for possible values

If true, employees with this role have all permissions, regardless of the values indicated in permissions.


        
  
  
          created_at
        


        

        
    string

The time when the employee entity was created, in ISO 8601 format. Is set by Square when the Role is created.


        
  
  
          updated_at
        


        

        
    string

The time when the employee entity was most recently updated, in ISO 8601 format. Is set by Square when the Role updated.

Object Index / Definition

You are viewing an old version of the API

All Versions

EmployeeRole
V1