Employees

List all employees for a given employer with pagination.

get/v1/employees

Request

Query parameters

employerIdstring required

ID of the employer to list employees for

limitstring

Maximum number of employees to return (default: 50)

offsetstring

Number of employees to skip (default: 0)

Response

Employees retrieved successfully

successboolean required
totalnumber required

Total number of employees returned

messagestring required

Changes

    • warning

      deleted the query request parameter activeAccount

    • warning

      deleted the query request parameter search

    • info

      added the new optional query request parameter activeAccount

    • info

      added the new optional query request parameter search