Skip to main content

Retrieve all workers from Onfleet

Retrieve all workers from Onfleet.

Application

  • Onfleet

Inputs (what you have)

NameDescriptionData TypeRequired?Example
Connected accountThe connected account to use for the requestConnected AccountYes
Search by location?Whether to search for only those workers who are currently within a certain target areaTrue/FalseYes
LongitudeThe longitude component of the coordinate pairNumber with decimalsYes
LatitudeThe latitude component of the coordinate pairNumber with decimalsYes
Return all?Whether to return all results or only up to a given limitTrue/FalseNo
LimitMax number of results to returnNumberNo
StatesList of worker statesText (Short)No
Team ID 1A list of the teams that workers must be part ofText (Short)No
Team ID 2A list of the teams that workers must be part ofText (Short)No
Team ID 3A list of the teams that workers must be part ofText (Short)No
PhonesA list of workers' phone numbersText (Short)No
Fields to returnA list of fields to show in the response, if all are not desiredPredefined Choice ListNo

Outputs (what you get)

NameDescriptionData TypeRequired?Example
JSON OutputJSON output returned by the APIText (Long)No

Outcomes

NameDescription
SuccessThis status is selected if the job has successfully completed.
UnsuccessfulThis status is selected if the job has completed unsuccessfully.

Requirements

  • N/A