employees.md

Employees

$employeesApi = $client->getEmployeesApi();

Class Name

EmployeesApi

Methods

• List Employees
• Retrieve Employee

List Employees

ListEmployees

function listEmployees(
    ?string $locationId = null,
    ?string $status = null,
    ?int $limit = null,
    ?string $cursor = null
): ApiResponse

Parameters

Parameter	Type	Tags	Description
locationId	?string	Query, Optional	-
status	?string (EmployeeStatus)	Query, Optional	Specifies the EmployeeStatus to filter the employee by.
limit	?int	Query, Optional	The number of employees to be returned on each page.
cursor	?string	Query, Optional	The token required to retrieve the specified page of results.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type ListEmployeesResponse.

Example Usage

$locationId = 'location_id4';
$status = Models\EmployeeStatus::ACTIVE;
$limit = 172;
$cursor = 'cursor6';

$apiResponse = $employeesApi->listEmployees($locationId, $status, $limit, $cursor);

if ($apiResponse->isSuccess()) {
    $listEmployeesResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

Retrieve Employee

RetrieveEmployee

function retrieveEmployee(string $id): ApiResponse

Parameters

Parameter	Type	Tags	Description
id	string	Template, Required	UUID for the employee that was requested.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type RetrieveEmployeeResponse.

Example Usage

$id = 'id0';

$apiResponse = $employeesApi->retrieveEmployee($id);

if ($apiResponse->isSuccess()) {
    $retrieveEmployeeResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();