Starfish (CampingCare/HotelCare) icon

Starfish (CampingCare/HotelCare)

Interact with the Starfish API for CampingCare and HotelCare
Join our community

Actions30

Overview

This node interacts with the Starfish API for CampingCare and HotelCare, specifically focusing on the Contacts API to retrieve contact information. It supports fetching detailed contact data or just the total count, with options to include related data such as invoice payments, invoices, meta information, reservation payment terms, and reservations. It allows filtering, sorting, and pagination of contacts, making it useful for managing and integrating contact data in automation workflows.

Use Case Examples

  1. Retrieve a list of contacts with detailed information including invoices and reservations for customer management.
  2. Get only the total count of contacts matching a search query for reporting purposes.
  3. Fetch contacts sorted by creation date in descending order with pagination for batch processing.

Properties

Name Meaning
Count Whether to return only the total count of contacts instead of full details.
Get Invoice Payments Whether to include invoice payments data in the response.
Get Invoices Whether to include invoice data in the response.
Get Meta Whether to include meta information about contacts.
Get Reservation Payment Terms Whether to include reservation payment terms data.
Get Reservations Whether to include reservations data.
Limit Maximum number of contacts to return, minimum value is 1.
Offset Number of contacts to skip before starting to collect results, minimum value is 0.
Order Sorting order of the returned contacts, either ascending (ASC) or descending (DESC).
Order By Field to sort the results by.
Search Filter contacts by ID or name with partial matches allowed.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • contacts - Array of contact objects with detailed information based on requested options.
  • totalCount - Total number of contacts matching the query when count option is true.
  • meta - Meta information about the contacts if requested.
  • invoices - Invoice data included if requested.
  • invoicePayments - Invoice payments data included if requested.
  • reservationPaymentTerms - Reservation payment terms data included if requested.
  • reservations - Reservations data included if requested.

Dependencies

  • Starfish API for CampingCare and HotelCare

Troubleshooting

  • Ensure the API key credential is correctly configured and has necessary permissions to access the Contacts API.
  • Check network connectivity and proxy settings if requests fail or time out.
  • Verify that the limit and offset values are within valid ranges to avoid errors.
  • If SSL certificate validation errors occur, consider enabling the option to ignore SSL issues, but be aware of security implications.

Links

Discussion