List addresses

Returns a list of addresses associated with a given account.

SecurityCommonAuth
Request
query Parameters
accountId
required
string (accountId)

The ID of the account to work with.

Example: accountId=F50091
limit
integer <int32> (limit) [ 1 .. 100000 ]
Default: 100

The maximum number of items to return.

Example: limit=100
offset
integer <int32> (offset)
Default: 0

The number of items to skip before returning the results.

Example: offset=200
search
string (search) <= 100 characters

The term to search the records for.

Example: search=Cesar+Treutel
type
Array of strings

The type to filter addresses by. Use commas to pass multiple values. Has to be URL encoded.

Example: type=registered%2Coffice
Responses
200

OK

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

get/addresses
Request samples 
Response samples 
application/json
{
  • "limit": 100,
  • "offset": 200,
  • "count": 67,
  • "search": "string",
  • "rows": [
    ]
}