v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB

V1Employees

ListEmployeeRoles

Provides summary information for all of a business's employee roles.

get/v1/me/roles

orderstring

The order in which employees are listed in the response, based on their created_at field.Default value: ASC

limitinteger

The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.

batch_tokenstring

A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Success

created_atstring

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

idstring

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

is_ownerboolean

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

namestring required

The role's merchant-defined name.

permissionsstring[] required

The role's permissions.

updated_atstring

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