employees.md

Employees

employees_api = client.employees

Class Name

EmployeesApi

Methods

• List Employees
• Retrieve Employee

List Employees

This endpoint is deprecated.

def list_employees(location_id: nil,
                   status: nil,
                   limit: nil,
                   cursor: nil)

Parameters

Parameter	Type	Tags	Description
location_id	String	Query, Optional	-
status	String (Employee Status)	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

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type List Employees Response Hash.

Example Usage

result = employees_api.list_employees

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Retrieve Employee

This endpoint is deprecated.

def retrieve_employee(id:)

Parameters

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

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type Retrieve Employee Response Hash.

Example Usage

id = 'id0'


result = employees_api.retrieve_employee(id: id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end