Actions19
- Company Actions
- Appointment Actions
- Item Type Actions
- Service Object Actions
- Service Request Actions
- Document Actions
- User Actions
- Report Actions
Overview
This node operation retrieves multiple user records from a Field Service Management system via its OData API. It is designed to fetch lists of users with optional filtering, expansion of related data, and control over the number of results returned.
Common scenarios where this node is beneficial include:
- Synchronizing user data from the field service platform into another system.
- Generating reports or dashboards that require user information.
- Automating workflows that depend on user attributes or roles.
For example, you could use this node to fetch all users who belong to a certain department (using a filter), or retrieve detailed contact information by expanding related fields.
Properties
| Name | Meaning |
|---|---|
| Limit | Maximum number of user records to return. Must be at least 1. |
| Fetch All Results | Boolean flag indicating whether to ignore the limit and fetch all available user records. If set to true, the node will paginate through all results until complete. |
| Filter | A string representing an OData filter expression to restrict which users are returned. For example, filtering by specific conditions on user properties. See OData filters documentation. |
| Expand | List of related entities to expand in the response, such as "Contact". Expanding includes additional hidden or related fields in the output. See Expand documentation. |
Output
The node outputs an array of JSON objects, each representing a user record retrieved from the API. The structure corresponds directly to the user entity schema exposed by the Field Service Management system's OData endpoint.
If the "Expand" property is used, related entities (e.g., Contact details) will be included within each user object under their respective keys.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating requests to the Field Service Management system's API.
- The node uses the OData REST API endpoints of the service, specifically the
/odata/Usersendpoint. - Pagination is handled internally by making repeated requests with
$topand$skipquery parameters.
Troubleshooting
- Empty results: Check the filter syntax and ensure it matches the OData specification. Also verify that the filter conditions actually match existing users.
- Partial results when not fetching all: If
Fetch All Resultsis false, the node respects theLimitproperty and may return fewer users than exist. - API authentication errors: Ensure the API key credential is valid and has sufficient permissions to read user data.
- Rate limiting or timeouts: When fetching all users, large datasets may cause timeouts or rate limits. Consider using filters or smaller limits.
- Invalid expand options: Only supported expansions like "Contact" should be used; invalid values may cause API errors.
