Actions7
- Agent Actions
- Group Actions
- Action Actions
Group → List
AI-generatedOverview
This node interacts with the Xcellerate.app API to list groups based on user-defined criteria. It is useful for scenarios where you need to retrieve a collection of groups, such as managing user groups, organizing data sets, or filtering groups by specific queries. For example, you can use it to fetch all groups or limit the results to a certain number, optionally filtering them with a query string.
Use Case Examples
- Retrieve all groups without limit to process or analyze them.
- Fetch a limited number of groups (e.g., 50) to display in a dashboard or report.
- Search for groups matching a specific query to find relevant data quickly.
Properties
| Name | Meaning |
|---|---|
| Return All | Determines whether to return all group results or limit the number of results returned. |
| Limit | Specifies the maximum number of group results to return when 'Return All' is false. |
| Query | A string to filter the groups by a search query, allowing for more specific results. |
Output
JSON
groups- An array of group objects returned from the API, each representing a group matching the criteria.
Dependencies
- Xcellerate.app API
Troubleshooting
- If the node returns no groups, verify the query string and ensure groups exist matching the criteria.
- If the node fails to authenticate, check the API key or authentication credentials for the Xcellerate.app API.
- If the limit is set too high and the node times out, try reducing the limit or enabling 'Return All' to paginate results properly.
Links
- Xcellerate.app API Documentation - Official API documentation for understanding available endpoints and parameters.