You are viewing an old version of the API
Retrieve employee role
V1

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

Provides the details for a single employee role

Required permissions EMPLOYEES_READ

Path Parameters

Name Description
role_id
string

Required

The role's ID.

Response Fields

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.

created_at
string

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

is_owner
boolean

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

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.

Examples

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

Share Feedback

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