Scoro icon

Scoro

Interact with the Scoro API

Overview

This node integrates with the Scoro API to retrieve multiple user records based on specified criteria. It is designed to fetch a list of users, optionally filtered by certain conditions, and supports pagination and batching to efficiently handle large datasets.

Common scenarios where this node is beneficial include:

  • Synchronizing user data from Scoro into another system.
  • Generating reports or analytics based on user information.
  • Automating workflows that require bulk user data retrieval.

For example, you might use this node to get all users modified after a specific date, or to include recently deleted users in your dataset for audit purposes.

Properties

Name Meaning
Options A collection of options to customize the query:
- Filter A JSON object used to filter results, e.g., { "modified_date": { "from_date": "2023-01-01" } }.
- Include Deleted Boolean flag indicating whether to include entries deleted in the last 30 days (true or false).
- Pagination Controls how many results to return:
-- Return All Whether to return all results (true) or limit the number (false).
-- Page Limit Maximum number of results to return if not returning all (minimum 1, default 50).
- Batching Controls batch request behavior to avoid rate limits:
-- Pages per Batch Number of pages requested concurrently in each batch (minimum 1, default 20).
-- Batch Interval (ms) Time in milliseconds to wait between batches (minimum 0, default 1000).

Output

The node outputs an array of user objects in the json field of its output data. Each object represents a user record retrieved from Scoro, containing fields as defined by the Scoro API's user resource schema.

If binary data were involved, it would be summarized here; however, this operation deals solely with JSON user 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 API endpoints to fetch user data.
  • Proper network access to the Scoro API endpoint is necessary.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Improperly formatted JSON in the Filter property can lead to parsing errors.
    • Requesting too many pages without batching may hit API rate limits.
    • Including deleted entries when none exist may return empty results.
  • Error Messages:

    • "Operation 'getAll' for resource 'user' is not supported." β€” This indicates a misconfiguration or unsupported operation/resource combination.
    • Authentication errors typically indicate invalid or missing API keys.
    • JSON parse errors suggest malformed filter input; ensure valid JSON syntax.
  • Resolutions:

    • Verify API credentials and permissions.
    • Validate JSON filter syntax before running.
    • Use batching options to manage large data requests and avoid rate limiting.
    • Adjust pagination settings to reasonable limits.

Links and References

  • Scoro API Documentation β€” Official API reference for understanding available user fields and filtering options.
  • n8n Documentation on Working with APIs β€” Guidance on configuring API credentials and handling pagination/batching.

Discussion