Actions77
- Columns Actions
- Comments Actions
- Companies Actions
- Currencies Actions
- Document Anchors Actions
- List Document Anchor
- List Basket Document Anchor
- Count Basket Document Anchor
- Check Edited Document Anchor
- Get By Id Document Anchor
- Update Document Anchor
- Delete Document Anchor
- Get Versions Document Anchor
- Get History Document Anchor
- Rotate Document Anchor
- Split Document Anchor
- Reassign Document Anchor
- Reassign All Document Anchor
- Redetect Document Anchor
- Get File Document Anchor
- Get Symbolic Links Document Anchor
- Get Group Treatments Document Anchor
- Get Group Documents Document Anchor
- Count Without Template Document Anchor
- List Without Template Document Anchor
- Set Template Document Anchor
- Transition Document Anchor
- Get State Document Anchor
- Update State Document Anchor
- Annotations Actions
- Expenses Actions
- Expense Categories Actions
- Expense Projects Actions
- Expense Reports Actions
- External Attachments Actions
- Fields Actions
- Files Actions
- Groups Actions
- Pending Transaction Actions
- Taxes Actions
- Tax Groups Actions
- Templates Actions
- Template Types Actions
- Streams Actions
- Users Actions
- Viridem Actions
Users → List User 2
AI-generatedOverview
This node operation lists users from the Viridem API based on specified filters such as company ID, active status, feed entity flag, and roles. It is useful for retrieving user data within a specific company context, filtering by user activity and roles, and optionally including feed entity information. Practical examples include fetching all active users in a company or retrieving users with specific roles for administrative purposes.
Use Case Examples
- Fetch all active users in company with ID 123.
- Retrieve users who are admins or regular users and are currently active.
Properties
| Name | Meaning |
|---|---|
| Company Id | The ID of the company to list users from. This is a required numeric input. |
| Is Active | Filter to list only active (1) or inactive (0) users. Defaults to active users. |
| Feed Entity | Boolean flag to include feed entity information in the user list. |
| Roles | JSON array of roles to filter users by, e.g., ['user', 'admin']. |
| Request Options | Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration. |
Output
JSON
users- Array of user objects returned from the API, each representing a user with their details.
Dependencies
- Viridem API OAuth2 credentials for authentication
Troubleshooting
- Ensure the Company Id is provided and valid, as it is required.
- Check network connectivity and proxy settings if requests fail.
- If SSL certificate validation fails, consider enabling the option to ignore SSL issues, but be aware of security risks.
- Timeout errors may occur if the server is slow; increase the timeout setting if needed.
Links
- Viridem API Users Documentation - Official API documentation for user-related endpoints in Viridem.