EmployeesApi

March 13, 2019 ยท View on GitHub

squareconnect.apis.employees_api

All endpoints are relative to Square Connect V2 Documentation

MethodHTTP request
list_employeesGET /v2/employees
retrieve_employeeGET /v2/employees/{id}

list_employees

ListEmployeesResponse list_employees(location_id=location_id, status=status, limit=limit, cursor=cursor)

Description

Gets a list of Employee objects for a business.

Parameters

NameTypeNotesDefault Value
location_idstr[optional]
statusstr[optional]
limitint[optional]
cursorstr[optional]

Return type

ListEmployeesResponse

Authorization

Assign your Access Token from developer portal to the authorization parameter.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_employee

RetrieveEmployeeResponse retrieve_employee(id)

Description

Gets an Employee by Square-assigned employee ID (UUID)

Parameters

NameTypeNotesDefault Value
idstr

Return type

RetrieveEmployeeResponse

Authorization

Assign your Access Token from developer portal to the authorization parameter.

[Back to top] [Back to API list] [Back to Model list] [Back to README]