Skip to main content

List Workers

Retrieves all workers. Use the search parameter to search for workers by name. The search is case-insensitive.

Secured by: Self-Service: Current Staffing Information, Worker Data: Public Worker Reports

Scope: Staffing.

Parameters​

ParameterDescription
LimitThe maximum number of objects in a single response. The default is 20. The maximum is 100.
OffsetThe zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Search-

Example Output​

{
    "data": [
        {
            "businessTitle": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
            "descriptor": "Lorem ipsum dolor sit ame",
            "href": "A link to the instance",
            "id": "Id of the instance",
            "isManager": true,
            "primarySupervisoryOrganization": {
                "descriptor": "A description of the instance",
                "href": "A link to the instance",
                "id": "wid / id / reference id"
            },
            "primaryWorkEmail": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
            "primaryWorkPhone": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu."
        }
    ],
    "total": 0
}

Workflow Library Example​

List Workers with Workday and Send Results Via Email

Workflow LibraryPreview this Workflow on desktop