Skip to main content
GET
List addresses

Authorizations

Authorization
string
header
required

Query Parameters

s
string

Filter addresses with a JSON-encoded condition passed as a string in the URL — ?s={"field":{"$operator":value}} — and combine conditions with $and / $or.

Operators$eq equals · $ne not equals · $gt $gte $lt $lte range · $between [min, max] · $cont $starts $ends text match · $in $notin value list · $isnull $notnull null check. Append L for case-insensitive text match ($contL, $startsL, …). Shorthand: {"field": value} is the same as {"field": {"$eq": value}}. Dates accept YYYY-MM-DD or full ISO 8601 (2026-06-01T00:00:00.000Z); filtering an unlisted field returns 400.

Filterable fields

Examples

Example:

"{\"externalId\":\"EXT-12345\"}"

page
integer

The page number to retrieve starting at 1

Response

200 - application/json

List of addresses

data
object[]
count
integer
total
integer
page
integer
pageCount
integer