Scoro icon

Scoro

Interact with the Scoro API

Actions46

Overview

This node interacts with the Scoro API to retrieve multiple client profiles in bulk. Specifically, the "Get Many" operation under the "ClientProfile" resource fetches a list of client profiles from the Scoro system. This is useful for scenarios where you need to synchronize or analyze client data, generate reports, or automate workflows that depend on client information.

Practical examples include:

  • Exporting all client profiles modified after a certain date.
  • Fetching client profiles including those recently deleted for audit purposes.
  • Paginating through large sets of client profiles efficiently without hitting rate limits.

Properties

Name Meaning
Options A collection of optional parameters to customize the retrieval:
- Filter JSON object to filter results, e.g., by modification date or other client profile attributes.
- Include Deleted Boolean flag to include entries deleted within the last 30 days.
- Pagination Controls how many results to return and whether to return all results or limit the number returned.
-- Return All Whether to return all matching results or only up to a specified limit.
-- Page Limit Maximum number of results to return if not returning all.
- Batching Controls batch request behavior to avoid rate limits:
-- Pages per Batch Number of pages requested concurrently in each batch.
-- Batch Interval (ms) Time in milliseconds to wait between batches of requests.

Output

The node outputs an array of client profile objects in the json field of the output items. Each object represents a client profile retrieved from Scoro, containing fields as defined by the Scoro API for client profiles (e.g., name, contact details, status). The output does not include binary data.

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 REST API endpoints to perform operations.
  • Proper network access to the Scoro API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrectly formatted JSON in the Filter property can cause parsing errors.
    • Requesting too many pages concurrently without proper batching may hit API rate limits.
    • Including deleted entries when none exist may return empty results.

  • Error messages:

    • "Operation 'getAll' for resource 'clientProfile' is not supported." — indicates a misconfiguration or unsupported operation; verify the selected resource and operation.
    • JSON parse errors on the Filter input — ensure valid JSON syntax.
    • API authentication errors — check API key validity and permissions.

  • Resolutions:

    • Validate and re-enter API credentials.
    • Use the provided JSON placeholder as a template for filters.
    • Adjust batching options to reduce concurrency or increase batch intervals.
    • Confirm the resource and operation selections match supported values.

Links and References

Discussion