AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter

Actions277

Overview

The "Organizations Index" operation for the "Organizations" resource retrieves a list of organizations with optional filtering and pagination. This node is useful when you want to query multiple organizations from a system, applying filters such as organization type, name, or MSP (Managed Service Provider) IDs. Practical examples include generating reports on organizations, syncing organization data into another system, or displaying filtered lists of organizations in dashboards.

Properties

Name Meaning
Additional Query Parameters Optional filters and pagination parameters that can be added to refine the organizations query. These include:
- Basic Info: Return only basic info about organizations (true/false). Defaults to true.
- Managed By Msp Id: Filter MSP sub-organizations by MSP ID (number).
- Name: Filter organizations by their name (string).
- Owned Msp Id: Filter parent organizations by MSP ID (number).
- Page: Pagination details as JSON object (e.g., page number and size).
- Type: Filter by organization type; options are Normal, Msp, or Sub Organization.

Output

The node outputs JSON data representing the list of organizations matching the query parameters. Each item in the output array corresponds to an organization object containing its details as returned by the API. The exact structure depends on the API response but typically includes fields like organization ID, name, type, and related MSP information.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the external service managing organizations.
  • The base URL for API requests is configured as https://api.dnsfilter.com.
  • The node uses standard HTTP headers for JSON content (Accept and Content-Type set to application/json).

Troubleshooting

  • Authentication errors: Ensure the API key credential is correctly configured and has necessary permissions.
  • Invalid query parameters: Passing unsupported or incorrectly formatted filter values may cause errors or empty results. Validate parameter types and formats before execution.
  • Pagination issues: Incorrectly structured pagination JSON may lead to unexpected results or errors. Confirm the pagination object matches expected API format.
  • Network or API downtime: Temporary connectivity issues or API unavailability will cause request failures. Retry after some time or check network settings.

Links and References

  • [API Documentation for Organizations Endpoint] (Not provided here; refer to your API provider's official docs)
  • n8n documentation on HTTP Request Node for understanding how API calls are made within nodes.

Discussion