Scoro icon

Scoro

Interact with the Scoro API

Actions46

Overview

This node interacts with the Scoro API to retrieve multiple calendar entries based on user-defined criteria. Specifically, the "Calendar" resource with the "Get Many" operation allows users to fetch a list of calendar events, optionally filtered by certain conditions, including deleted entries, and supports pagination and batching.

Common scenarios where this node is beneficial include:

  • Synchronizing calendar events from Scoro into another system or workflow.
  • Generating reports or dashboards that require bulk calendar data.
  • Automating workflows that depend on calendar event data, such as reminders or notifications.

For example, a user might want to retrieve all calendar events modified since January 1, 2023, excluding deleted entries, and process them in batches to avoid hitting API rate limits.

Properties

Name Meaning
Options Collection of options to customize the retrieval of calendar events:
- Filter A JSON object used to filter results, e.g., by modification date.
- Include Deleted Boolean flag indicating whether to include entries deleted in the last 30 days.
- Pagination Controls how many results to return:
-- Return All Whether to return all matching results or limit the number returned.
-- Page Limit Maximum number of results to return if not returning all.
- Batching Controls batch request behavior to manage rate limits:
-- Pages per Batch Number of pages requested concurrently in each batch.
-- Batch Interval (ms) Time in milliseconds to wait between each batch of requests.

Output

The node outputs an array of calendar event objects in the json field of each item. Each object represents a calendar entry retrieved from Scoro, containing fields as defined by the Scoro API for calendar events (e.g., event ID, title, start/end times, status).

If binary data were involved (not indicated here), it would be summarized accordingly, but this node focuses on JSON data representing calendar events.

Dependencies

  • Requires an API key credential for authenticating with the Scoro API.
  • Needs the base URL and company account ID configured in the credentials.
  • The node uses the Scoro API endpoints to fetch calendar data.
  • Proper network access to Scoro's API endpoint is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrectly formatted JSON in the Filter property may cause parsing errors.
    • Requesting too many pages without batching may hit API rate limits.
    • Setting "Return All" without batching can lead to long execution times or timeouts.

  • Error Messages:

    • "Operation 'getAll' for resource 'calendar' is not supported." — This indicates a mismatch in operation or resource names; ensure correct selection.
    • JSON parse errors when using the Filter option — verify the JSON syntax is valid.
    • API errors related to authentication — check API key and base URL correctness.

  • Resolutions:

    • Validate and re-enter API credentials.
    • Use the provided JSON placeholder as a template for filters.
    • Use batching options to control request concurrency and intervals.
    • Limit the number of results or enable pagination to reduce load.

Links and References

Discussion