API V2 Route: Physical Addresses
Last updated: August 28, 2026
General Details:
| Endpoint |
/api/v2/physical-addresses and /api/v2/physical-addresses/<id>
|
| Headers | Authorization: <JWT> |
| HTTP Methods |
GET and POST
|
GET Details:
| Request Body Format | N/A |
| Response Body Format | JSON |
| Required Scopes | PHYSICAL_ADDRESSES_GET |
API Response:
| Field Name | Data Type | Notes |
|---|---|---|
| id | string | Globally unique identifier |
| streetAddress | string | |
| streetAddress2 | string | |
| city | string | |
| state | string | |
| zip | string | |
| countryCode | string |
POST Details:
| Request Body Format | JSON |
| Response Body Format | JSON |
| Required Scopes | PHYSICAL_ADDRESSES_POST |
POST Behavior:
Housing.Cloud will create or update the Physical Address entity based on the existence (or lack there of) of a the id.
POST API Request Body:
Housing.Cloud supports batch creation, as such every POST payload should contain an array of objects with the following structure:
| Field Name | Data Type | Required | Notes |
|---|---|---|---|
| id | string | No | Globally unique identifier |
| streetAddress | string | Yes | |
| streetAddress2 | string | No | |
| city | string | Yes | |
| state | string | No | |
| zip | string | No | |
| countryCode | string | No |