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 integrates with the AvantGuard CIPP API to retrieve contacts associated with a specific list. It is designed to fetch detailed contact information filtered by a given contact ID and tenant filter. This functionality is useful in scenarios where you need to programmatically access and manage contact data within lists, such as syncing contacts for marketing campaigns, auditing contact details, or integrating contact data into other workflows.
For example, you might use this node to:
- Retrieve all contacts linked to a particular list identified by a contact ID.
- Filter contacts based on tenant-specific criteria to segment data appropriately.
- Automate contact data retrieval for reporting or further processing in your automation workflows.
Properties
| Name | Meaning |
|---|---|
| Contactid | The unique identifier of the contact whose details you want to retrieve. |
| Tenantfilter | A string used to filter contacts based on tenant-specific criteria or segmentation. |
Output
The node outputs JSON data containing the retrieved contact information from the specified list. The structure of the json output field corresponds to the response from the AvantGuard CIPP API's endpoint for retrieving list contacts. It typically includes contact details such as names, IDs, and any other relevant metadata provided by the API.
If the API supports binary data (e.g., attachments or files related to contacts), the node would handle it accordingly, but based on the provided code and properties, the primary output is JSON-formatted contact data.
Dependencies
- Requires an API key credential for authenticating with the AvantGuard CIPP API.
- The node depends on the external AvantGuard CIPP API service, accessible via a base URL configured in the node credentials.
- Uses the
@avantguardllc/n8n-openapi-nodepackage to build request properties from the OpenAPI specification (openapi.json).
Troubleshooting
- Missing or invalid API credentials: Ensure that the API key and base URL are correctly configured in the node credentials; otherwise, authentication will fail.
- Invalid or missing required parameters: Both
ContactidandTenantfilterare required. Omitting these or providing incorrect values may result in errors or empty responses. - Network issues or API downtime: Connectivity problems or service outages at AvantGuard CIPP API can cause request failures.
- Unexpected API responses: If the API changes or returns unexpected data structures, the node might not parse the output correctly.
To resolve common errors:
- Double-check the input property values for correctness.
- Verify API credentials and network connectivity.
- Consult AvantGuard CIPP API documentation for any updates or changes in endpoints or parameters.
Links and References
- AvantGuard CIPP API Documentation (example placeholder link)
- n8n Documentation - Creating Custom Nodes
- OpenAPI Specification