NetSapiens icon

NetSapiens

Interact with the NetSapiens API

Actions477

Addresses → Get Addresses for User

AI-generated

Summary

Fetch the list of addresses associated with a specified user within a chosen domain.

Inputs

  • refreshOptions — Bypass cached dropdown values and fetch fresh options
  • domain (required) — Domain to query, selected from the domain list
  • user (required) — User identifier or list entry to query
  • GetAddressesForUser__pagination__returnAll — Whether to fetch all results by increasing the API limit
  • GetAddressesForUser__query__limit — Limit parameter for pagination (required when returnAll is false)
  • GetAddressesForUser__query__show_all_personal — Set to "yes" to include all personal addresses regardless of user identity, requires Office Manager or above
  • GetAddressesForUser__query__show_only_personal — Set to "yes" to show only personal addresses

Output shape

a list of address objects

Pagination controlled by returnAll and limit; optional flags affect visibility of personal addresses.

Examples

Example 1: Retrieve all addresses for a specific user in a domain

domain = example.com, user = 1001, returnAll = true

Example 2: Fetch only personal addresses with default pagination

domain = example.com, user = 1001, show_only_personal = yes

Example 3: Refresh dropdown cache and get fresh options for a domain

refreshOptions = true, domain = example.com, user = 1001

Links

Discussion