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

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

Provides the details for a single employee

Required permissions EMPLOYEES_READ

Path Parameters

Name Description
employee_id
string

Required

The employee's ID.

Response Fields

Name Description
id
string

The employee's unique ID.

first_name
string

Required

The employee's first name.

last_name
string

Required

The employee's last name.

authorized_location_ids
string [ ]

The IDs of the locations the employee is allowed to clock in at.

created_at
string

The time when the employee entity was created, in ISO 8601 format.

email
string

The employee's email address.

external_id
string

An ID the merchant can set to associate the employee with an entity in another system.

role_ids
string [ ]

The ids of the employee's associated roles. Currently, you can specify only one or zero roles per employee.

status
string

CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard.

updated_at
string

The time when the employee entity was most recently updated, in ISO 8601 format.

Examples

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

Share Feedback

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