employees.md

Employees

IEmployeesApi employeesApi = client.EmployeesApi;

Class Name

EmployeesApi

Methods

• List Employees
• Retrieve Employee

List Employees

ListEmployees

ListEmployeesAsync(
    string locationId = null,
    string status = null,
    int? limit = null,
    string cursor = null)

Parameters

Parameter	Type	Tags	Description
locationId	string	Query, Optional	Filter employees returned to only those that are associated with the specified location.
status	string	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

Task<Models.ListEmployeesResponse>

Example Usage

try
{
    ListEmployeesResponse result = await employeesApi.ListEmployeesAsync(null, null, null, null);
}
catch (ApiException e){};

Retrieve Employee

RetrieveEmployee

RetrieveEmployeeAsync(string id)

Parameters

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

Response Type

Task<Models.RetrieveEmployeeResponse>

Example Usage

string id = "id0";

try
{
    RetrieveEmployeeResponse result = await employeesApi.RetrieveEmployeeAsync(id);
}
catch (ApiException e){};