List Departments

Retrieve a list of departments from SmartHR.

Options

Field Definition Type Required
Result Set

Choose one of the following options to return your results:

  • First 100 Records: Returns the first 100 matching records.

  • Stream Records: Passes all matching user records from your parent flow to a helper flow. Adds a Streaming input section to the card where you can select a helper flow for streaming and adding custom extensible fields.

Dropdown TRUE

To learn how to return large numbers of records, see Stream matching records with a helper flow.

Input

Field Definition Type Required
Department
Code Department code. Text FALSE
Streaming
Flow

Click Choose Flow to browse and select a helper flow where the search results will be streamed, then click Choose to confirm.

Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow.

This field appears when Stream Records is selected from the Result Set field.

The input field on the Helper Card in the streaming helper flow must reference the key Record (type object) to obtain streamed records. To obtain state input values, reference the key State (type object) of the Record object.

Flow TRUE
Record Limit

Specify the number of records to stream.

  • When the Record Limit field is set to 0, no records are returned.

  • When the Record Limit field is set to greater than 0, records greater than 0 and up the maximum number of records specified are returned.

  • When the Record Limit field is empty, null or not selected, all records are streamed.

  • Default value is 500000.

  • Valid range is from 0 to 500000.

This field appears when Stream Records is selected from the Result Set option.

Number TRUE

Output

Field Definition Type
Result
Departments Object (List)
Department ID Unique identifier for the department. Text
Name Department name. Text
Position Department position. Number
Code Department code. Text
Parent

Parent department for the specified department.

  • Department ID (Text) - Unique identifier for the department

  • Name (Text) - Department name

  • Position (Number) - Department position

  • Code (Text) - Department code

  • Parent (Object) - Department's parent department

Object
Children

Child departments of the specified department.

  • Department ID (Text) - Unique identifier for the department

  • Name (Text) - Department name

  • Position (Number) - Department position

  • Code (Text) - Department code

Object (List)
Created At Date created. Date & Time
Updated At Last updated. Date & Time
Result
Records Streamed

Number of records streamed in a streaming flow.

This field appears when you select Stream Records from the Result Set option.

Number

Related topics

SmartHR connector

Workflow elements

SmartHR API documentation