activities
latest
false
UiPath logo, featuring letters U and I in white

Integration Service Activities

Last updated Mar 12, 2026

Search Workers by Name or ID

Project compatibility

Windows | Cross-platform

Overview

DescriptionAPI MethodAPI Path (relative)
Searches Workday workers by name or ID and returns a paged list of workers. GET/workers

Input

ParameterDescriptionData type
Search string or IDSearches for workers by name or ID. Typically sent as search or similar query parameter and supports space‑delimited search for OR conditions. string
Include terminated workersIndicates whether workers with a terminated status should be included in the response (implementation‑specific query flag). boolean
Max recordsMaximum number of worker records to return in a single response page (commonly controlled by limit or pageSize). int32
Next pageCursor or offset token used to request the next page of results in a paginated response. string

Output

ParameterDescriptionData type
WorkersCollection of worker records matching the search criteriaArray
Note:
  • In API workflows, a single response object is returned as the output. Any required fields can be extracted directly from this object.
  • In RPA workflows, some output parameters may differ, but the necessary values can still be retrieved from the response object even if they are not explicitly exposed.
  • Project compatibility
  • Overview
  • Input
  • Output

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated