Scoro icon

Scoro

Interact with the Scoro API

Overview

This node integrates with the Scoro API to retrieve multiple Role entries based on specified criteria. It is designed to fetch many Role records, optionally filtered and paginated, making it useful for scenarios where you need to synchronize or analyze user roles from Scoro within your workflows.

Practical examples include:

  • Extracting all active roles in a company for reporting.
  • Filtering roles modified after a certain date to update an external system.
  • Including recently deleted roles to audit changes.

Properties

Name Meaning
Options A collection of options to customize the retrieval:
- Filter JSON object to filter results, e.g., by modification date or other fields.
- Include Deleted Boolean flag 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 avoid rate limits:
-- Pages per Batch Number of pages requested concurrently in each batch.
-- Batch Interval (ms) Time in milliseconds to wait between batches.

Output

The node outputs JSON data representing the retrieved Role entries from Scoro. Each item corresponds to a Role object as returned by the Scoro API, including all relevant fields such as role name, permissions, and metadata.

No binary data output is produced by this operation.

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 the "get many" operation on Roles.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrectly formatted JSON in the Filter property may cause parsing errors.
    • Request limits might be hit if batching parameters are too aggressive or omitted.
  • Error messages:

    • "Operation 'getAll' for resource 'role' is not supported." indicates a misconfiguration or unsupported operation/resource combination.
    • JSON parse errors when entering filter criteria can be resolved by ensuring valid JSON syntax.
    • Rate limit errors can be mitigated by adjusting batching options (reducing pages per batch or increasing batch interval).

Links and References

Discussion