Actions60
- General Actions
- Mission Actions
- Client Actions
- Agent Actions
- Invoice Actions
- Contact Actions
- Alert Actions
- Walter Actions
- Notification Actions
- Webhook Actions
- Route Actions
- Export Actions
Agent → Get Many
AI-generatedOverview
This node operation retrieves multiple agent records from the Everest Transport Management System (TMS). It supports filtering and pagination options to customize the list of agents returned. This is useful for scenarios where you need to fetch a list of agents based on specific criteria such as availability, activity status, mission dates, or search terms. For example, you can use it to get all active agents who are currently available or to find agents who had missions within a certain date range.
Use Case Examples
- Fetch up to 50 agents who are currently available and active.
- Retrieve agents starting from a specific offset for pagination.
- Search agents by name, email, or phone with a specific search term.
- Get agents who have missions within a specified date range.
Properties
| Name | Meaning |
|---|---|
| Limit | Maximum number of agent results to return. |
| Limit Start | Starting offset for pagination (0-based index). |
| Search | Search term to filter agents by name, email, or phone. |
| Available Only | Filter to show only agents who are currently available. |
| Active Only | Filter to show only active agent accounts. |
| Start Date From | Filter agents who had missions starting from this date/time (Europe/Paris timezone). |
| Start Date To | Filter agents who had missions until this date/time (Europe/Paris timezone). |
| With Missions Only | If true, returns only agents who have missions, can be used without date filters. |
Output
JSON
agents- Array of agent objects matching the filter criteria and pagination options.
Dependencies
- Requires an API key credential for Everest TMS to authenticate requests.
Troubleshooting
- Common issues include invalid or missing API credentials, resulting in authentication errors.
- Incorrect date formats for the date filters may cause the request to fail or return no results.
- Using pagination parameters incorrectly (e.g., negative offsets) may lead to unexpected results or errors.
- If the search term is too broad or empty, the returned list may be very large or empty if no matches are found.