Actions50
- Status Actions
- Task Actions
- Calendar Actions
- ClientProfile Actions
- Comment Actions
- Company Actions
- Invoice Actions
- Project Actions
- Role Actions
- Time Entry Actions
- Trigger Actions
- User Actions
Overview
This node interacts with the Scoro API to retrieve multiple Role entries based on specified criteria. It is designed to fetch many Role records, optionally filtered by custom JSON filters, including or excluding recently deleted entries, and supports pagination and batching to efficiently handle large datasets.
Common scenarios where this node is beneficial include:
- Synchronizing user roles from Scoro into another system.
- Generating reports or analytics based on roles data.
- Automating workflows that depend on role information, such as access control or notifications.
Practical example:
- Fetch all active roles modified since a specific date to update an internal directory.
- Retrieve roles in batches of pages with delays between batches to avoid hitting API rate limits.
Properties
| Name | Meaning |
|---|---|
| Options | Collection of options to customize the retrieval: |
| - Filter | A JSON object used to filter results, e.g., filtering roles modified after a certain date. The JSON must be valid and will be parsed before sending. |
| - Include Deleted | Boolean flag indicating whether to include entries deleted within the last 30 days. If true, deleted roles are included in the results. |
| - 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. Helps avoid rate limits by limiting concurrency. |
| -- Batch Interval (ms) | Time in milliseconds to wait between each batch of requests. Adds delay to reduce risk of hitting rate limits. |
Output
The node outputs JSON data representing the retrieved Role entries from Scoro. Each item in the output corresponds to a Role record with its associated fields as returned by the Scoro API.
If the node supports binary data output, it would typically represent attachments or files related to roles, but based on the provided code and properties, this operation focuses on JSON data only.
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 corresponding to the Role resource.
- Proper network connectivity to the Scoro API endpoint is necessary.
Troubleshooting
- Invalid JSON in Filter: If the filter JSON is malformed, the node may throw a parsing error. Ensure the filter input is valid JSON.
- API Authentication Errors: Missing or incorrect API key or company account ID will cause authentication failures. Verify credentials are correctly set.
- Rate Limits: Requesting too many pages without batching or delays may trigger API rate limits. Use batching options to mitigate this.
- Unsupported Operation: Selecting an unsupported operation-resource combination will result in an error stating the operation is not supported.
- Empty Results: If no roles match the filter criteria, the output will be empty. Adjust filters accordingly.
Links and References
- Scoro API Documentation — Official API docs for understanding available endpoints and parameters.
- n8n Documentation — For general guidance on using n8n nodes and handling credentials.