Voalle icon

Voalle

Interact with Voalle API

Actions64

Suite → Listar Locais

AI-generated

Overview

This node interacts with the Voalle API to list company places within the Suite resource. It is useful for retrieving paginated lists of company locations, optionally filtered and ordered according to user-defined criteria. Practical applications include managing and displaying company site information in business workflows or integrating location data into other systems.

Use Case Examples

  1. Retrieve the first page of company places with a page size of 10 to display in a dashboard.
  2. Filter company places by a specific attribute and order the results by name for reporting purposes.

Properties

Name Meaning
Page The page number of the results to retrieve, used for pagination.
PageSize The number of items to retrieve per page, controlling the size of the paginated response.
Filter An optional string to filter the list of company places based on specific criteria.
OrderBy An optional string to specify the ordering of the results.

Output

JSON

  • json - The JSON response from the Voalle API containing the list of company places according to the specified pagination, filter, and order parameters.

Dependencies

  • Voalle API authentication credentials are required to access the Voalle API endpoints.

Troubleshooting

  • If the operation is not implemented or the operation name is incorrect, the node throws an error indicating the operation is not implemented.
  • Ensure that the Voalle API credentials are correctly configured and valid to avoid authentication errors.
  • Verify that the pagination parameters (Page and PageSize) are set to valid numbers to prevent request errors.

Discussion