Addressesv1
List addresses
Handler: ListAddresses. Returns a bare array of addresses. Optional filters: rec_id, rec_type, type.
Authorization
bearerAuth AuthorizationBearer <token>
JWT bearer token (auth.WrapWithMiddlewares)
In: header
Query Parameters
rec_id?string
Filter by owning record ID
rec_type?string
Filter by owning record type. Free-form string set by the owning module (e.g. customers, signatories); no fixed enum is enforced.
type?string
Filter by address type
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/addresses"[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"rec_id": "0ba687c4-349e-490d-969f-fd374e232d42",
"rec_type": "string",
"type": "registration",
"street": "string",
"number": "string",
"additional": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string",
"is_primary": true,
"address_hash": "string",
"active": true,
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"modified_at": "2019-08-24T14:15:22Z",
"modified_by": "e8d4374d-93a1-4e98-a6c6-fdcf00c5059f"
}
]{
"status": 403,
"message": "Forbidden"
}