Actions22
Organisation → Get All
AI-generatedOverview
This node interacts with the Supportpal API to retrieve all organisation records based on specified query parameters. It supports filtering organisations by brand ID, pagination controls (start and limit), and sorting options (order column and direction). Additionally, it allows adding custom fields to the query. This operation is useful for scenarios where you need to fetch multiple organisation entries from Supportpal, such as generating reports, syncing organisation data, or bulk processing organisations.
Use Case Examples
- Fetch all organisations registered under a specific brand ID with pagination and sorting.
- Retrieve all organisations with custom fields included for detailed data analysis.
Properties
| Name | Meaning |
|---|---|
| Simplify Response | If enabled, returns a simplified response containing only the organisation data. |
| Query Parameters | Parameters to filter, paginate, and sort the list of organisations retrieved. |
| Custom Fields | Custom fields to include in the query for additional organisation data. |
Output
JSON
id- Unique identifier of the organisation.name- Name of the organisation.brand_id- Identifier of the brand the organisation is registered to.customfield- Custom fields associated with the organisation, if any.
Dependencies
- Supportpal REST API
Troubleshooting
- Ensure the API credentials are correctly configured to avoid authentication errors.
- Verify that the query parameters are valid and supported by the Supportpal API to prevent request failures.
- If the response is empty, check that the filter criteria (e.g., brand ID) match existing organisations in the system.
Links
- Supportpal API Documentation - Official documentation for the Supportpal REST API used by this node.