Scoro icon

Scoro

Interact with the Scoro API

Overview

This node interacts with the Scoro API to retrieve multiple user records based on specified criteria. It is designed to fetch many users at once, supporting filtering, 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 could use this node to get all users modified since a certain date, or to paginate through users in batches to avoid hitting API rate limits.

Properties

Name Meaning
Options Collection of options to customize the query:
- Filter A JSON object used to filter results, e.g., by modification date.
- 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 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 user objects in the json field of the output items. Each object represents a user record retrieved from Scoro, containing fields as defined by the Scoro API for users.

If the node supports binary data output (not indicated here), it would typically represent files or attachments related to users, but this node focuses on 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.
  • No additional external dependencies beyond the Scoro API and n8n's HTTP request capabilities.

Troubleshooting

  • Unsupported Operation Error: If you select an operation-resource combination not supported, the node throws an error indicating the operation is unsupported. Ensure "Get Many" is selected for the "User" resource.
  • API Authentication Errors: Missing or invalid API keys will cause authentication failures. Verify your API key and base URL are correctly set in credentials.
  • Rate Limits: Fetching large datasets without batching may hit API rate limits. Use the batching options to control concurrency and delay between requests.
  • Invalid Filter JSON: Providing malformed JSON in the filter option will cause parsing errors. Ensure the filter JSON is valid.
  • Pagination Misconfiguration: Setting page limits too high or disabling return all without proper limits may result in incomplete data or excessive API calls.

Links and References

Discussion