TOTVS RM icon

TOTVS RM

Interact with TOTVS ERP Linha RM — DataServer REST, native REST APIs, and automatic JWT authentication

Employees (HR) → List Employees

AI-generated

Summary

List employees from the TOTVS RM Employees (HR) DataServer using optional filtering, pagination, field selection, ordering, and context parameters.

Inputs

  • SQL Filter — A standard RM SQL filter string to filter employees, supporting operators like =, LIKE, AND, OR, IN. For example, NOME LIKE '%JOHN%'.
  • Page Size (limit) — Maximum number of employee records to return in one call, defaulting to 50, with allowed range 1 to 500.
  • Offset (start) — Record offset to start the list from (for pagination), defaulting to 0.
  • Order By — Field and direction(s) to order the results by, e.g., NOME ASC.
  • Select Fields — Comma-separated list of specific employee fields to return; leaving empty returns all fields.
  • Company Code Override — Optional numeric company code to override the credential's default company code; leave as 0 to use the credential default.
  • RM Context — Optional additional RM context string with parameters like CODSISTEMA, CODUSUARIO, CODFILIAL; uses credential defaults if not provided.

Output shape

a list of JSON objects representing employee records matching the query parameters

Supports pagination via 'Page Size' and 'Offset'; filtering, ordering, and field selection are optional. The output shape is an array of JSON employee records. Errors are returned per item if 'continue on fail' is enabled.

Links

Discussion