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
Fields → List Field
AI-generatedOverview
This node operation lists fields associated with a specified company in the Viridem system. It supports filtering by keywords and pagination options, making it useful for retrieving manageable chunks of field data for a company. Typical use cases include fetching field metadata for display, processing, or integration with other systems.
Use Case Examples
- Retrieve the first page of fields for a company with ID 123, showing 15 fields per page.
- Search for fields containing specific keywords within a company and paginate through the results.
Properties
| Name | Meaning |
|---|---|
| Company Id | The unique identifier of the company whose fields are to be listed. |
| Keywords | Optional search keywords to filter the fields by name or other attributes. |
| Page | The page number of results to retrieve, used for pagination. |
| Per Page | The number of fields to return per page, controlling the size of each paginated result set. |
| Request Options | Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout. |
Output
JSON
fields- An array of field objects returned from the API, representing the fields associated with the specified company.paginationpage- The current page number of the results.per_page- The number of fields returned per page.total- The total number of fields available for the company.
Dependencies
- Viridem OAuth2 API credential for authentication
Troubleshooting
- Ensure the Company Id is valid and the user has access rights to the company's data to avoid authorization errors.
- If no fields are returned, verify that the keywords filter is correct or try removing it to get all fields.
- Timeout errors may occur if the server is slow or unresponsive; increase the timeout setting in Request Options if needed.
- SSL certificate errors can be bypassed by enabling the 'Ignore SSL Issues' option, but use this with caution as it reduces security.