Gambio icon

Gambio

Interact with Gambio REST API v3

Actions220

Address (v2) → Get Many

AI-generated

Summary

Retrieve a list of customer addresses from the Gambio API v2, optionally applying filters and pagination.

Inputs

  • Authentication (required) — Choose between Basic Auth (admin email and password, compatible with v2 and v3 API) or Bearer Token (JWT, compatible with v3 API only). Defaults to Basic Auth.
  • Additional Fields — Optional query parameters including 'fields' (comma-separated list of fields to return), 'page' (0-based page number), 'perPage' (results per page, default 50), 'search' (keyword to search addresses), and 'sort' (sorting order, e.g. '+lastname', '-firstname').
  • Request Options — Node-level request options such as batching settings (batch size and interval), SSL certificate validation override, HTTP proxy configuration, and request timeout in milliseconds.

Output shape

a list of address records as returned by the Gambio API v2 /api.php/v2/addresses endpoint

The operation supports pagination via 'page' and 'perPage' query parameters. The returned data structure matches the Gambio API v2 specification for customer addresses. If 'fields' is specified, only those fields will be included in the response items. Error responses from the API will be surfaced as node execution errors.

Examples

Example 1: Retrieve the first 50 addresses with default settings

Set Resource to 'Address (v2)', Operation to 'Get Many', and optionally configure authentication

Example 2: Retrieve addresses filtered by a search keyword and sorted by lastname ascending

Set the 'search' parameter in Additional Fields to the desired keyword and 'sort' parameter to '+lastname'

Discussion