employees.md

Employees

EmployeesApi employeesApi = client.getEmployeesApi();

Class Name

EmployeesApi

Methods

• List Employees
• Retrieve Employee

List Employees

This endpoint is deprecated.

CompletableFuture<ListEmployeesResponse> listEmployeesAsync(
    final String locationId,
    final String status,
    final Integer limit,
    final String cursor)

Parameters

Parameter	Type	Tags	Description
locationId	String	Query, Optional	-
status	String	Query, Optional	Specifies the EmployeeStatus to filter the employee by.
limit	Integer	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

ListEmployeesResponse

Example Usage

employeesApi.listEmployeesAsync(null, null, null, null).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Retrieve Employee

This endpoint is deprecated.

CompletableFuture<RetrieveEmployeeResponse> retrieveEmployeeAsync(
    final String id)

Parameters

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

Response Type

RetrieveEmployeeResponse

Example Usage

String id = "id0";

employeesApi.retrieveEmployeeAsync(id).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});