Actions19
- Company Actions
- Appointment Actions
- Item Type Actions
- Service Object Actions
- Service Request Actions
- Document Actions
- User Actions
- Report Actions
Overview
This node integrates with a field service management system to retrieve detailed information about a specific company. It allows users to fetch a company's data by either selecting from a searchable list or providing the company ID directly. Additionally, it supports expanding related hidden fields such as contacts, tags, service objects, and main contact details.
Common scenarios where this node is beneficial include:
- Automating workflows that require fetching company details for reporting or processing.
- Integrating company data into other systems or dashboards.
- Enriching service requests or appointments with company-related information.
Practical example:
- A user wants to automatically pull detailed company information including its contacts and tags when a new service request is created, enabling better context for technicians or customer support.
Properties
| Name | Meaning |
|---|---|
| Company to Get | Select the company to retrieve by searching from a list of companies or by entering the company ID (numeric). |
| Expand | Choose related hidden fields to expand in the response. Options: Contacts, Tags, Service Objects, Main Contact. |
Output
The output is a JSON object representing the requested company's data as returned by the external API. If any expansions are selected, the output will include nested objects or arrays corresponding to those expanded fields (e.g., contacts, tags).
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating requests to the external Field Service Management API.
- The node makes HTTP GET requests to the API endpoint
https://portal.mobilefieldreport.com/odata/Companies({companyId}L)with optional OData query parameters for expansion. - Proper configuration of the API authentication credential within n8n is necessary.
Troubleshooting
- Invalid Company ID: If the provided company ID is not numeric, the node will reject it due to validation rules. Ensure the ID consists only of digits.
- Company Not Found: If the company ID or name does not exist in the system, the API may return an error or empty result. Verify the input value.
- Authentication Errors: If the API key credential is missing or invalid, requests will fail. Confirm the credential setup.
- Expand Parameter Issues: Selecting expansions that do not exist or are misspelled may cause API errors. Use only the supported options listed.
- Network or API Downtime: Temporary connectivity issues or API outages can cause failures. Retry after some time or check API status.
Links and References
- OData Expand Documentation — Details on how to use the
$expandparameter to include related entities in responses.