Actions136
- List Actions
- Retrieve List User Mailbox Rules
- Retrieve List User Photo
- Retrieve List Users
- Retrieve List User Sign In Logs
- Retrieve Public Phishing Check
- Retrieve Edit Ca Policy
- Retrieve Edit Exconnector
- Retrieve Edit Spam Filter
- Retrieve Edit Transport Rule
- Retrieve Exec Edit Calendar Permissions
- Retrieve List Deleted Items
- Retrieve Exec Add Spn
- Retrieve Exec Add Trusted Ip
- Retrieve Exec Alerts List
- Retrieve Exec App Approval
- Retrieve Exec Assign App
- Retrieve Exec Assign Policy
- Retrieve Exec Auto Extend Gdap
- Retrieve Exec Bec Check
- Retrieve Exec Clr Imm Id
- Retrieve Exec Convert To Shared Mailbox
- Retrieve Exec Copy For Sent
- Retrieve Exec Cpv Permissions
- Retrieve Exec Create Tap
- Retrieve Exec Delete Gdap Relationship
- Retrieve Exec Delete Gdap Role Mapping
- Retrieve Exec Device Delete
- Retrieve Exec Disable User
- Retrieve Exec Dns Config
- Retrieve Exec Enable Archive
- Retrieve Exec Extension Mapping
- Retrieve Exec Extension Sync
- Retrieve Exec Extension Test
- Retrieve Exec Geo Ip Lookup
- Retrieve Exec Get Local Admin Password
- Retrieve Exec Get Recovery Key
- Retrieve Exec Graph Request
- Retrieve Exec Groups Delete
- Retrieve Exec Groups Delivery Management
- Retrieve Exec Groups Hide From Gal
- Retrieve Exec Hide From Gal
- Retrieve Exec Incidents List
- Retrieve Exec Mailbox Mobile Devices
- Retrieve Exec Maintenance Scripts
- Retrieve Exec Quarantine Management
- Retrieve Exec Reset Mfa
- Retrieve Exec Reset Pass
- Retrieve Exec Restore Deleted
- Retrieve Exec Revoke Sessions
- Retrieve Exec Run Backup
- Retrieve Exec Send Org Message
- Retrieve Exec Send Push
- Retrieve Exec Set Security Alert
- Retrieve Exec Set Security Incident
- Retrieve Exec Standards Run
- Retrieve Exec Sync Ap Devices
- Retrieve Exec Universal Search
- Retrieve Domain Analyser List
- Retrieve Get CIPP Alerts
- Retrieve Get Version
- Retrieve List All Tenant Device Compliance
- Retrieve List Ap Devices
- Retrieve List Apps
- Retrieve List App Status
- Retrieve List Auto Pilot Config
- Retrieve List Azure AD Connect Status
- Retrieve List Basic Auth
- Retrieve List Bpa
- Retrieve List Bpa Templates
- Retrieve List Calendar Permission
- Retrieve List Ca Templates
- Retrieve List Conditional Access P Olicies
- Retrieve List Contacts
- Retrieve List Defender State
- Retrieve List Defender Tvm
- Retrieve List Device Details
- Retrieve List Device
- Retrieve List Domain Analyser
- Retrieve List Domain Health
- Retrieve List Domains
- Retrieve List Exchange Connectors
- Retrieve List Ex Connector Template
- Retrieve List External Tenant Info
- Retrieve List Function Parameters
- Retrieve List Function Stats
- Retrieve List GDAP Invite
- Retrieve List Graph Request
- Retrieve List Groups
- Retrieve List Group Templates
- Retrieve List Inactive Accounts
- Retrieve List Intune Intents
- Retrieve List Intune Policy
- Retrieve List Intune Templates
- Retrieve List Known Ipdb
- Retrieve List Licenses
- Retrieve List Logs
- Retrieve List Mailbox Cas
- Retrieve List Mailboxes
- Retrieve List Mailbox Mobile Devices
- Retrieve List Mailbox Mobile Devices Copy
- Retrieve List Mailbox Permissions
- Retrieve List Mailbox Restores
- Retrieve List Mailbox Rules
- Retrieve List Mailbox Statistics
- Retrieve List Mail Quarantine
- Retrieve List Message Trace
- Retrieve List Mfa Users
- Retrieve List Named Locations
- Retrieve List Oauth Apps
- Retrieve List Ooo
- Retrieve List Org
- Retrieve List Partner Relationships
- Retrieve List Phish Policies
- Retrieve List Recipients
- Retrieve List Roles
- Retrieve List Shared Mailbox Account Enabled
- Retrieve List Shared Mailbox Statistics
- Retrieve List Sharepoint Quota
- Retrieve List Sharepoint Settings
- Retrieve List Signins
- Retrieve List Sites
- Retrieve List Spam Filter
- Retrieve List Spam Filter Templates
- Retrieve List Standards
- Retrieve List Teams
- Retrieve List Teams Activity
- Retrieve List Teams Voice
- Retrieve List Tenant Details
- Retrieve List Tenants
- Retrieve List Transport Rules
- Retrieve List Transport Rules Templates
- Retrieve List User Conditional Access Policies
- Retrieve List User Counts
- Retrieve List User Devices
- Retrieve List User Groups
- Retrieve List User Mailbox Details
Overview
This node operation, "Retrieve List Graph Request" under the "List" resource, is designed to perform a graph-based query on a list resource via an API. It allows users to specify various parameters that control the nature of the graph request, such as filtering criteria, pagination behavior, and which properties to retrieve. This can be useful in scenarios where you need to extract complex relational data or aggregated information from a list endpoint that supports graph queries.
Practical examples include:
- Retrieving a filtered subset of items from a large dataset with specific properties.
- Counting items matching certain criteria without retrieving full data (using count-only mode).
- Fetching graph-related data structures for visualization or further processing.
Properties
| Name | Meaning |
|---|---|
| Countonly | Whether to return only the count of matching items instead of full data. |
| Endpoint | The API endpoint path to target for the graph request. |
| Graphfilter | Filter expression to apply on the graph query to limit results. |
| Ignoreerrors | Flag indicating whether to ignore errors during the request processing. |
| Listproperties | Specifies which properties of the list items to retrieve in the response. |
| Nopagination | Indicates whether to disable pagination and retrieve all results in one request. |
| (Unnamed) | An unnamed required string property included in the query parameters (purpose unclear). |
Output
The node outputs JSON data representing the result of the graph request against the list resource. This JSON typically contains the requested list items or counts based on the input parameters. The structure depends on the API's response format but generally includes the filtered list data with specified properties.
No binary data output is indicated by the source code or properties.
Dependencies
- Requires an API key credential for authentication to the AvantGuard CIPP API.
- Needs the base URL of the API resource, provided via credentials.
- Depends on the
@avantguardllc/n8n-openapi-nodepackage for building properties and handling requests. - The node sends HTTP requests with headers specifying JSON content type and expects JSON responses.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Providing invalid filter expressions or endpoint paths may result in API errors.
- Omitting required properties like
countonly,endpoint, orgraphfilterwill likely cause the request to fail. - The unnamed required property without a display name might confuse users; ensure it is set correctly or clarify its purpose.
Error messages:
- Authentication errors: Verify API key and base URL credentials.
- Validation errors from the API: Check the correctness of query parameters, especially filters and endpoint.
- Network errors: Confirm network connectivity and API availability.
Links and References
- AvantGuard CIPP API Documentation (hypothetical link, replace with actual if available)
- n8n Custom Node Development
- OpenAPI Specification