You are viewing an old version of the API
List employee roles
V1

Note We recommend using the Square API (V2) for all new development when possible.

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

Required permissions EMPLOYEES_READ

Query Parameters

Name Description
order
string

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

limit
integer

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

batch_token
string

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

Response Fields

Name Description
{items}
V1​Employee​Role [ ]

Root array of on V1EmployeeRole objects on the response

Examples

You are viewing an old version of the API
GET /v1/me/roles
cURL
  • cURL
curl https://connect.squareup.com/v1/me/roles \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?